-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
IMPROVE: rewrite schemas in YAML (#123)
# General * VERSION: v0.21.0 * IMPROVE: rewrite schemas in YAML (#123) * CHANGE: minor changes to `description` fields of schemas * DOCS: update CONTRIBUTING.md (see #127) * DEV: add build script (`npm run build`) * DEP: azure-storage@2.10.1 * DEP: jasmine@3.2.0 # Location * CHANGE: reference GeoJSON schema from DLx directly, rather than schemastore.org # Orthography * FIX: type for "name" field incorrectly set to "string" instead of "object"
- Loading branch information
Showing
106 changed files
with
5,450 additions
and
1,898 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| schemas/json/index.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /** | ||
| * Converts all the YAML versions of the DLx schemas to JSON, | ||
| * and saves them to /schemas/json | ||
| */ | ||
|
|
||
| /* eslint-disable | ||
| no-shadow, | ||
| */ | ||
|
|
||
| // IMPORTS | ||
| const path = require(`path`); | ||
| const yamljs = require(`yamljs`); | ||
|
|
||
| const { | ||
| readdir, | ||
| readFile, | ||
| writeFile, | ||
| } = require(`fs`).promises; | ||
|
|
||
| // VARIABLES | ||
| const schemasPath = path.join(__dirname, `../schemas`); | ||
|
|
||
| // METHODS | ||
|
|
||
| /** | ||
| * Reads a schema from a filename and returns an Object containing "name" and "schema" attributes | ||
| * @param {String} filename The filename of the schema to read | ||
| * @return {Object} | ||
| */ | ||
| async function readSchema(filename) { | ||
|
|
||
| const schema = await readFile(path.join(schemasPath, `yaml`, filename), `utf8`); | ||
|
|
||
| return { | ||
| name: filename.replace(`.yml`, ``), | ||
| schema, | ||
| }; | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Writes a converted schema object to a JSON file in the /schemas/json folder | ||
| * @param {String} name The name of the schema | ||
| * @param {Object} schema The schema as a JavaScript Object | ||
| * @return {Promise} Returns a Promise that resolves when complete | ||
| */ | ||
| async function writeSchema({ name, schema }) { | ||
| const schemaPath = path.join(schemasPath, `json/${name}.json`); | ||
| const json = JSON.stringify(schema, null, 2); | ||
| await writeFile(schemaPath, json, `utf8`); | ||
| } | ||
|
|
||
| // TOP-LEVEL SCRIPT | ||
| void async function convert() { | ||
|
|
||
| // Read all the schemas from their YAML files | ||
| const filenames = await readdir(path.join(schemasPath, `yaml`)); | ||
| const schemas = await Promise.all(filenames.map(readSchema)); | ||
|
|
||
| // Parse each schema into JavaScript | ||
| schemas.forEach(schema => { | ||
| // eslint-disable-next-line no-param-reassign | ||
| schema.schema = yamljs.parse(schema.schema); | ||
| }); | ||
|
|
||
| // Write the schemas to /schemas/json | ||
| await Promise.all(schemas.map(writeSchema)); | ||
|
|
||
| // Update schemas/json/index.js | ||
| const lines = schemas | ||
| .map(({ name }) => name) | ||
| .map(name => ` ${name}: require('./${name}'),`) | ||
| .join(`\n`); | ||
|
|
||
| const indexText = `module.exports = {\n${lines}\n};`; | ||
| const indexPath = path.join(schemasPath, `json/index.js`); | ||
|
|
||
| await writeFile(indexPath, indexText, `utf8`); | ||
|
|
||
| }(); |
Oops, something went wrong.