hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 01:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move generated documentation to docs/lint/

Browse Source
This commit is contained in:
Yury Bondarenko
2024-03-29 10:12:41 +01:00
parent a6e093038c
commit 2c68589416
5 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
lint/.gitignore vendored
View File

@@ -1,4 +1,3 @@
/dist/ /dist/
/coverage/ /coverage/
/node-modules/ /node-modules/
/docs/

4
lint/README.md
View File

@@ -5,8 +5,8 @@ Custom ESLint rules for DSpace Angular peculiarities.
## Documentation ## Documentation
The rules are split up into plugins by language: The rules are split up into plugins by language:
- [TypeScript rules](./docs/ts/index.md) - [TypeScript rules](../docs/lint/ts/index.md)
- [HTML rules](./docs/html/index.md) - [HTML rules](../docs/lint/html/index.md)
> Run `yarn docs:lint` to generate this documentation! > Run `yarn docs:lint` to generate this documentation!

2
lint/generate-docs.ts
View File

@@ -28,7 +28,7 @@ function lazyEJS(path: string, data: object) {
return templates.get(path)(data); return templates.get(path)(data);
} }
const docsDir = join('lint', 'docs'); const docsDir = join('docs', 'lint');
const tsDir = join(docsDir, 'ts'); const tsDir = join(docsDir, 'ts');
const htmlDir = join(docsDir, 'html'); const htmlDir = join(docsDir, 'html');

2
lint/src/util/templates/index.ejs
View File

@@ -1,4 +1,4 @@
[DSpace ESLint plugins](../../README.md) > <%= plugin.language %> rules [DSpace ESLint plugins](../../../lint/README.md) > <%= plugin.language %> rules
<% rules.forEach(rule => { %> <% rules.forEach(rule => { %>
- [`<%= plugin.name %>/<%= rule.name %>`](./rules/<%= rule.name %>.md)<% if (rule.meta?.docs?.description) {%>: <%= rule.meta.docs.description.split('\n')[0] %><% }%> - [`<%= plugin.name %>/<%= rule.name %>`](./rules/<%= rule.name %>.md)<% if (rule.meta?.docs?.description) {%>: <%= rule.meta.docs.description.split('\n')[0] %><% }%>

4
lint/src/util/templates/rule.ejs
View File

@@ -1,11 +1,11 @@
[DSpace ESLint plugins](../../../README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>` [DSpace ESLint plugins](../../../../lint/README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>`
_______ _______
<%- rule.meta.docs?.description %> <%- rule.meta.docs?.description %>
_______ _______
[Source code](../../../src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts) [Source code](../../../../lint/src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts)
### Examples ### Examples