Skip to content
Snippets Groups Projects
Commit f96a6f55 authored by Lars Trieloff's avatar Lars Trieloff
Browse files

Include schema status in README

parent 439e6a16
Branches 48-readme-status
Tags
No related merge requests found
Pipeline #186 failed
Stage: build
Stage: test
Hide whitespace changes
Inline Side-by-side
cli.js 100644 → 100755
+ 0
− 0
View file @ f96a6f55
File mode changed from 100644 to 100755
examples/docs/README.md
+ 17
− 17
View file @ f96a6f55
...@@ -6,24 +6,24 @@ ...@@ -6,24 +6,24 @@
## / ## /
* [Abstract](./abstract.schema.md) – `https://example.com/schemas/abstract` * [Abstract](./abstract.schema.md) – `https://example.com/schemas/abstract` (Unknown)
* [Arrays](./arrays.schema.md) – `https://example.com/schemas/arrays` * [Arrays](./arrays.schema.md) – `https://example.com/schemas/arrays` (Unknown)
* [Complex References ](./complex.schema.md) – `https://example.com/schemas/complex` * [Complex References ](./complex.schema.md) – `https://example.com/schemas/complex` (Unknown)
* [Constant Types](./constants.schema.md) – `https://example.com/schemas/constants` * [Constant Types](./constants.schema.md) – `https://example.com/schemas/constants` (Unknown)
* [Custom](./custom.schema.md) – `https://example.com/schemas/custom` * [Custom](./custom.schema.md) – `https://example.com/schemas/custom` (Unknown)
* [Deeply Extending](./deepextending.schema.md) – `https://example.com/schemas/deepextending` * [Deeply Extending](./deepextending.schema.md) – `https://example.com/schemas/deepextending` (Unknown)
* [Definitions](./definitions.schema.md) – `https://example.com/schemas/definitions` * [Definitions](./definitions.schema.md) – `https://example.com/schemas/definitions` (Unknown)
* [Enumerated ](./enums.schema.md) – `https://example.com/schemas/enums` * [Enumerated ](./enums.schema.md) – `https://example.com/schemas/enums` (Unknown)
* [Example](./example.schema.md) – `https://example.com/schemas/example` * [Example](./example.schema.md) – `https://example.com/schemas/example` (Unknown)
* [Examples](./examples.schema.md) – `https://example.com/schemas/examples` * [Examples](./examples.schema.md) – `https://example.com/schemas/examples` (Unknown)
* [Extending](./extending.schema.md) – `https://example.com/schemas/extending` * [Extending](./extending.schema.md) – `https://example.com/schemas/extending` (Unknown)
* [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible` * [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible` (Unknown)
* [Identifiable](./identifiable.schema.md) – `https://example.com/schemas/identifiable` * [Identifiable](./identifiable.schema.md) – `https://example.com/schemas/identifiable` (Unknown)
* [Simple](./simple.schema.md) – `https://example.com/schemas/simple` * [Simple](./simple.schema.md) – `https://example.com/schemas/simple` (Unknown)
* [Simple Types](./simpletypes.schema.md) – `https://example.com/schemas/simpletypes` * [Simple Types](./simpletypes.schema.md) – `https://example.com/schemas/simpletypes` (Unknown)
* [Stabilizing](./stabilizing.schema.md) – `https://example.com/schemas/stabilizing` * [Stabilizing](./stabilizing.schema.md) – `https://example.com/schemas/stabilizing` (Stabilizing)
## /subdir/ ## /subdir/
* [Subdir](./subdir/subdir.schema.md) – `https://example.com/schemas/subdir/subdir` * [Subdir](./subdir/subdir.schema.md) – `https://example.com/schemas/subdir/subdir` (Unknown)
lib/readmeWriter.js
+ 1
− 0
View file @ f96a6f55
...@@ -38,6 +38,7 @@ const generateReadme = function(paths, schemas, out, base) { ...@@ -38,6 +38,7 @@ const generateReadme = function(paths, schemas, out, base) {
id: schema.jsonSchema.$id, id: schema.jsonSchema.$id,
title: schema.jsonSchema.title, title: schema.jsonSchema.title,
full: schema.filePath, full: schema.filePath,
status: schema.jsonSchema['meta:status'] !== undefined ? (schema.jsonSchema['meta:status'].charAt(0).toUpperCase() + schema.jsonSchema['meta:status'].slice(1)) : 'Unknown',
relative: relativePath(schema.filePath, base), relative: relativePath(schema.filePath, base),
dir: directory(schema.filePath, base), dir: directory(schema.filePath, base),
}; };
......
spec/examples/README.md
+ 17
− 17
View file @ f96a6f55
...@@ -6,24 +6,24 @@ ...@@ -6,24 +6,24 @@
## / ## /
* [Abstract](./abstract.schema.md) – `https://example.com/schemas/abstract` * [Abstract](./abstract.schema.md) – `https://example.com/schemas/abstract` (Unknown)
* [Arrays](./arrays.schema.md) – `https://example.com/schemas/arrays` * [Arrays](./arrays.schema.md) – `https://example.com/schemas/arrays` (Unknown)
* [Complex References ](./complex.schema.md) – `https://example.com/schemas/complex` * [Complex References ](./complex.schema.md) – `https://example.com/schemas/complex` (Unknown)
* [Constant Types](./constants.schema.md) – `https://example.com/schemas/constants` * [Constant Types](./constants.schema.md) – `https://example.com/schemas/constants` (Unknown)
* [Custom](./custom.schema.md) – `https://example.com/schemas/custom` * [Custom](./custom.schema.md) – `https://example.com/schemas/custom` (Unknown)
* [Deeply Extending](./deepextending.schema.md) – `https://example.com/schemas/deepextending` * [Deeply Extending](./deepextending.schema.md) – `https://example.com/schemas/deepextending` (Unknown)
* [Definitions](./definitions.schema.md) – `https://example.com/schemas/definitions` * [Definitions](./definitions.schema.md) – `https://example.com/schemas/definitions` (Unknown)
* [Enumerated ](./enums.schema.md) – `https://example.com/schemas/enums` * [Enumerated ](./enums.schema.md) – `https://example.com/schemas/enums` (Unknown)
* [Example](./example.schema.md) – `https://example.com/schemas/example` * [Example](./example.schema.md) – `https://example.com/schemas/example` (Unknown)
* [Examples](./examples.schema.md) – `https://example.com/schemas/examples` * [Examples](./examples.schema.md) – `https://example.com/schemas/examples` (Unknown)
* [Extending](./extending.schema.md) – `https://example.com/schemas/extending` * [Extending](./extending.schema.md) – `https://example.com/schemas/extending` (Unknown)
* [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible` * [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible` (Unknown)
* [Identifiable](./identifiable.schema.md) – `https://example.com/schemas/identifiable` * [Identifiable](./identifiable.schema.md) – `https://example.com/schemas/identifiable` (Unknown)
* [Simple](./simple.schema.md) – `https://example.com/schemas/simple` * [Simple](./simple.schema.md) – `https://example.com/schemas/simple` (Unknown)
* [Simple Types](./simpletypes.schema.md) – `https://example.com/schemas/simpletypes` * [Simple Types](./simpletypes.schema.md) – `https://example.com/schemas/simpletypes` (Unknown)
* [Stabilizing](./stabilizing.schema.md) – `https://example.com/schemas/stabilizing` * [Stabilizing](./stabilizing.schema.md) – `https://example.com/schemas/stabilizing` (Stabilizing)
## /subdir/ ## /subdir/
* [Subdir](./subdir/subdir.schema.md) – `https://example.com/schemas/subdir/subdir` * [Subdir](./subdir/subdir.schema.md) – `https://example.com/schemas/subdir/subdir` (Unknown)
spec/lib/integrationTest.spec.js
+ 0
− 1
View file @ f96a6f55
...@@ -50,7 +50,6 @@ describe('Compare results', () => { ...@@ -50,7 +50,6 @@ describe('Compare results', () => {
'--link-status', '--link-status',
'status.md' 'status.md'
]); ]);
ls.on('close', code => { ls.on('close', code => {
expect(code).toEqual(0); expect(code).toEqual(0);
......
templates/md/readme.ejs
+ 1
− 1
View file @ f96a6f55
...@@ -11,5 +11,5 @@ ...@@ -11,5 +11,5 @@
<% _.forIn(groups, (schemas, group) => { %> <% _.forIn(groups, (schemas, group) => { %>
## <%= group %> ## <%= group %>
<% _.forEach(_.sortBy(schemas, [o => { return o.title }]), schema => { %> <% _.forEach(_.sortBy(schemas, [o => { return o.title }]), schema => { %>
* [<%= schema.title %>](.<%= schema.relative %>.schema.md) – `<%= schema.id %>`<% }); %> * [<%= schema.title %>](.<%= schema.relative %>.schema.md) – `<%= schema.id %>` (<%= schema.status %>)<% }); %>
<% }); %> <% }); %>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment