Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
@Relequestual
Relequestual authored Jun 21, 2024
2 parents 8f8b2cb + ccb62cd commit 33aaa19
Show file tree
Hide file tree
Showing 4 changed files with 436 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vscode
12 changes: 5 additions & 7 deletions projects/initial-data/main.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ export async function processRepository(octokit, owner, repo) {
throw new Error(`Unable to get releases for ${owner}/${repo}`);
}
const repoTopics = await fetchRepoTopics(octokit, owner, repo);

let firstCommitDate;
try {
firstCommitDate = await fetchFirstCommitDate(octokit, owner, repo);
Expand All @@ -115,6 +116,7 @@ export async function processRepository(octokit, owner, repo) {
throw new Error(`Error trying to find first commit for ${owner}/${repo}`);
}
console.log({ firstReleaseDate });

if (firstReleaseDate === null) {
console.log(`First release date: of ${githubRepoURL} unknown`);
}
Expand All @@ -141,10 +143,9 @@ async function main(token, topic, numRepos) {
q: `topic:${topic}`,
per_page: 100,
});
console.log(iterator);
let processedRepos = 0;

const dataRecorder = new DataRecorder(CSV_FILE_NAME);
const dataRecorder = new DataRecorder(`./data/${CSV_FILE_NAME}`);

for await (const iteration of iterator) {
const data = iteration.data;
Expand All @@ -156,18 +157,15 @@ async function main(token, topic, numRepos) {
repo.owner.login,
repo.name,
);
console.log({ dataRow });

dataRecorder.appendToCSV(Object.values(dataRow));
processedRepos++;
console.log(`processed ${processedRepos}`);
}
catch (err) {
} catch (err) {
console.error(err);
}
if (numRepos !== -1 && processedRepos >= numRepos) break;
}
}

};


Expand Down
313 changes: 313 additions & 0 deletions projects/tooling-self-identification/identification.schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://schemas.json-schema.org/ecosystem/identification-v-0.0.1",
"title": "Tooling Project Self Identification Document",
"$comment": "Decided not to use JSON-LD and Schema.org concepts, as this complicates things without a clear benefit for our use case.",
"description": "This is a schema which represents a self reporting document published by a JSON Schema tooling creator, maintainer, or vendor.",
"$defs": {
"persons": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"required": [
"username",
"platform"
],
"properties": {
"name": {
"description": "The persons name, should they wish to provide it",
"type": "string"
},
"email": {
"description": ""
},
"username": {
"description": "The persons username on the platform where the user exists",
"type": "string"
},
"platform": {
"type": "string",
"anyOf": [
{
"enum": [
"github",
"gitlab",
"bitbucket"
]
},
{
"description": "A string value not yet included in the list of platforms"
}
]
},
"additionalProperties": false
}
}
}
},
"type": "object",
"properties": {
"$schema": {
"description": "Identifies the exact version of the schema and self reporting data structure to which the file intends to conform",
"type": "string",
"pattern": "https://schemas.json-schema.org/ecosystem/identification-v-\\d\\.\\d\\.\\d"
},
"name": {
"description": "The name of the project",
"type": "string"
},
"description": {
"description": "A brief description of the project",
"$comment": "If this is omitted and description is already defined on GitHub or GitLab for the repository, we will use that information.",
"type": "string"
},
"toolingTypes": {
"description": "The categories of tooling for the project",
"type": "array",
"uniqueItems": true,
"items": {
"description": "One of the categories of tooling of the project",
"type": "string",
"enum": [
"validator",
"hyper-schema",
"benchmarks",
"documentation",
"LDO-utility",
"code-to-schema",
"data-to-schema",
"model-to-schema",
"schema-to-types",
"schema-to-code",
"schema-to-web-UI",
"schema-to-data",
"util-general-processing",
"util-schema-to-schema",
"util-draft-migration",
"util-format-conversion",
"util-testing",
"editor",
"editor-plugins",
"schema-repository",
"linter",
"linter-plugins"
]
}
},
"languages": {
"description": "The language or languages a tool is built in. In the case of a validator, this will likely be the language it is written in. In the case of a conversion or transformation tool, these are the languages that are supported in some capacity.",
"type": "array",
"items": {
"description": "Individual language name, from the list unless not included.",
"type": "string",
"anyOf": [
{
"enum": [
[
"Common Lisp",
"Rust",
"Elm",
".NET",
"PHP",
"Clojure",
"Python",
"XSD",
"Scala",
"Orderly",
"Kotlin",
"Elixir",
"RAML",
"Erlang",
"Java",
"Lua/LuaJIT",
"OpenAPI",
"Perl",
"TypeScript",
"Ruby",
"Objective-C",
"Swift",
"C#",
"Go",
"C++",
"JavaScript"
]
]
},
{
"description": "A string value not yet included in the list of languages"
}
]
}
},
"environments": {
"description": "The platforms or environments in which the tool or library is designed to operate. This field is optional and should be included when the tool or library is specific to a certain platform or environment.",
"type": "array",
"items": {
"type": "string",
"anyOf": [
{
"enum": [
"Web (Online)",
"GitHub Actions",
"Command Line",
"COM/ActiveX"
]
},
{
"description": "A string value not yet included in the list of environments"
}
]
}
},
"dependsOnValidators": {
"description": "Documents if the tool is the primary validator provider or depends on another tool",
"type": "array",
"items": {
"description": "One of the tools that this tool depends upon",
"$comment": "This should be the source URL. The source URL should already be known to the ecosystem repository in some way.",
"type": "string",
"format": "uri"
}
},
"creators": {
"description": "The creators or authors of the project",
"$ref": "#/$defs/persons"
},
"maintainers": {
"description": "The maintainers of the project",
"$ref": "#/$defs/persons"
},
"license": {
"description": "The license under which the project is distributed. SPDX expressions or a URL.",
"$comment": "Schemastore package.json schema uses enum to assist in auto complete. Could be worth doing the same.",
"type": "string"
},
"source": {
"description": "The URL of the project's repository",
"type": "string",
"format": "uri"
},
"homepage": {
"description": "The URL of the project's homepage",
"type": "string",
"format": "uri"
},
"documentation": {
"$comment": "This is reserved for future use",
"type": "object"
},
"supportedDialects": {
"description": "The declared supported dialects of JSON Schema. This includes draft version identifiers.",
"type": "object",
"properties": {
"draft": {
"description": "An array of dialects of JSON Schema.",
"type": "array",
"items": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
"2019-09",
"2020-12"
]
}
},
"additional": {
"description": "Additional Dialects that are supported beyond the ones defined by the JSON Schema project, such as the OpenAPI Dialect.",
"type": "array",
"items": {
"description": "Individual JSON Schema Dialect items",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"homepage": {
"type": "string",
"format": "uri"
},
"source": {
"type": "string",
"format": "uri"
}
},
"required": [
"name",
"source"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"bowtie": {
"description": "Information related to compliance testing by Bowtie - https://bowtie.report - Presence of this property implies the tool is being tested in Bowtie",
"type": "object",
"properties": {
"identifier": {
"description": "The identifier used for the tool in Bowtie, including the language.",
"examples": [
"dotnet-jsonschema-net",
"js-ajv"
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"toolingListingNotes": {
"description": "Notes about the tooling which will appear in the tooling listing on the website.",
"type": "string"
},
"compliance": {
"description": "Details on what must be done to make the implementation the most compliant that it can be. This is displayed on the website with the tooling details",
"type": "object",
"properties": {
"config": {
"type": "object",
"properties": {
"docs": {
"description": "A URL which links to the documentation which explains how to follow the given instructions.",
"type": "string"
},
"instructions": {
"description": "Instructions on how to make the implementation the most compliant.",
"type": "string"
}
}
}
}
},
"landscape": {
"description": "Additional information that should be used when generating the JSON Schema landscape diagram - https://github.com/json-schema-org/landscape",
"type": "object",
"properties": {
"logo": {
"description": "The filename of the logo to use for the JSON Schema landscape diagram - Must be included in the landscape repo under the logos directory, and in SVG format.",
"type": "string"
},
"optOut": {
"description": "Set this value to a boolean `true` value if you do not wish to be included in the JSON Schema Landscape. If you do, we would like to hear why.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}
},
"required": [
"name",
"source",
"toolingTypes"
],
"additionalProperties": false
}
Loading

0 comments on commit 33aaa19

Please sign in to comment.