fix: docs generation

This commit is contained in:
2024-07-02 17:56:03 +02:00
committed by Jovan Krunić
parent 343d03e647
commit 802a7a3fa7
15 changed files with 12 additions and 27 deletions

View File

@@ -0,0 +1,5 @@
---
"@openstapps/easy-ast": patch
---
Fixed docs generation

View File

@@ -13,6 +13,7 @@
"deploy": "dotenv -c -- turbo run deploy --concurrency=1", "deploy": "dotenv -c -- turbo run deploy --concurrency=1",
"dev": "dotenv -c -- turbo run dev", "dev": "dotenv -c -- turbo run dev",
"docs": "dotenv -c -- turbo run docs && typedoc && mkdir docs/api && cp packages/core/lib/api-doc.html docs/api/index.html && cp packages/core/lib/openapi.json docs/api/openapi.json && cp -r packages/core/lib/schema docs/api/schema", "docs": "dotenv -c -- turbo run docs && typedoc && mkdir docs/api && cp packages/core/lib/api-doc.html docs/api/index.html && cp packages/core/lib/openapi.json docs/api/openapi.json && cp -r packages/core/lib/schema docs/api/schema",
"docs:serve": "http-server docs -p 8080 -o",
"format": "dotenv -c -- turbo run format", "format": "dotenv -c -- turbo run format",
"format:fix": "dotenv -c -- turbo run format:fix", "format:fix": "dotenv -c -- turbo run format:fix",
"lint": "dotenv -c -- turbo run lint", "lint": "dotenv -c -- turbo run lint",
@@ -34,6 +35,7 @@
"deepmerge": "4.3.1", "deepmerge": "4.3.1",
"dotenv-cli": "7.2.1", "dotenv-cli": "7.2.1",
"glob": "10.3.10", "glob": "10.3.10",
"http-server": "14.1.1",
"junit-report-merger": "6.0.3", "junit-report-merger": "6.0.3",
"prettier": "3.1.1", "prettier": "3.1.1",
"syncpack": "12.3.0", "syncpack": "12.3.0",

View File

@@ -17,10 +17,8 @@ import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
import {TypeFlags} from 'typescript'; import {TypeFlags} from 'typescript';
// @ts-expect-error unused type
type TestTypeAlias = number | string; type TestTypeAlias = number | string;
// @ts-expect-error unused type
enum TestEnum { enum TestEnum {
Foo, Foo,
Bar, Bar,

View File

@@ -18,13 +18,9 @@ import {LightweightDefinitionKind} from '../../src/index.js';
interface Random {} interface Random {}
// @ts-expect-error unused type
type TestArrayGeneric = Array<string>; type TestArrayGeneric = Array<string>;
// @ts-expect-error unused type
type TestArrayLiteral = number[]; type TestArrayLiteral = number[];
// @ts-expect-error unused type
type TestArrayReferenceGeneric = Array<Random>; type TestArrayReferenceGeneric = Array<Random>;
// @ts-expect-error unused type
type TestArrayReferenceLiteral = Random[]; type TestArrayReferenceLiteral = Random[];
export const testConfig: EasyAstSpecType = { export const testConfig: EasyAstSpecType = {

View File

@@ -16,12 +16,10 @@
import {EasyAstSpecType} from '../easy-ast-spec-type.js'; import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
// @ts-expect-error unused type
interface TestInterface { interface TestInterface {
foo: number; foo: number;
} }
// @ts-expect-error unused type
class TestClass { class TestClass {
bar: string = 'test'; bar: string = 'test';
} }

View File

@@ -22,10 +22,8 @@ import {LightweightDefinitionKind} from '../../src/index.js';
* Class description * Class description
* *
* More description * More description
*
* @classTag classParameter1 classParameter2 * @classTag classParameter1 classParameter2
*/ */
// @ts-expect-error unused type
interface TestInterface { interface TestInterface {
/** /**
* Property comment * Property comment
@@ -33,7 +31,6 @@ interface TestInterface {
* Property description * Property description
* *
* More description * More description
*
* @propertyTag propertyParameter1 propertyParameter2 * @propertyTag propertyParameter1 propertyParameter2
*/ */
foo: string; foo: string;
@@ -45,10 +42,8 @@ interface TestInterface {
* Class description * Class description
* *
* More description * More description
*
* @classTag classParameter1 classParameter2 * @classTag classParameter1 classParameter2
*/ */
// @ts-expect-error unused type
class TestClass { class TestClass {
/** /**
* Property comment * Property comment
@@ -56,7 +51,6 @@ class TestClass {
* Property description * Property description
* *
* More description * More description
*
* @propertyTag propertyParameter1 propertyParameter2 * @propertyTag propertyParameter1 propertyParameter2
*/ */
foo = 1; foo = 1;
@@ -68,10 +62,8 @@ class TestClass {
* Enum description * Enum description
* *
* More description * More description
*
* @enumTag enumParameter1 * @enumTag enumParameter1
*/ */
// @ts-expect-error unused type
enum TestAlias {} enum TestAlias {}
export const testConfig: EasyAstSpecType = { export const testConfig: EasyAstSpecType = {

View File

@@ -20,7 +20,6 @@ interface Test1<T = number> {
foo: T; foo: T;
} }
// @ts-expect-error unused type
interface Test2 { interface Test2 {
bar: Test1; bar: Test1;
} }

View File

@@ -17,13 +17,11 @@ import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
import {TypeFlags} from 'typescript'; import {TypeFlags} from 'typescript';
// @ts-expect-error unused type
enum TestAuto { enum TestAuto {
Foo, Foo,
Bar, Bar,
} }
// @ts-expect-error unused type
enum TestSpecified { enum TestSpecified {
YES = 'yes', YES = 'yes',
NO = 'no', NO = 'no',

View File

@@ -18,7 +18,6 @@ import {LightweightDefinitionKind} from '../../src/index.js';
interface $Random {} interface $Random {}
// @ts-expect-error unused type
interface Generics { interface Generics {
baz: Foo<number, $Random>; baz: Foo<number, $Random>;
} }

View File

@@ -18,12 +18,10 @@ import {LightweightDefinitionKind} from '../../src/index.js';
interface $Random {} interface $Random {}
// @ts-expect-error unused
interface IndexSignatureObject { interface IndexSignatureObject {
[key: string]: $Random; [key: string]: $Random;
} }
// @ts-expect-error unused
interface IndexSignaturePrimitive { interface IndexSignaturePrimitive {
[key: string]: number; [key: string]: number;
} }

View File

@@ -26,7 +26,6 @@ interface $BaseInterface2 {
class $BaseClass {} class $BaseClass {}
// @ts-expect-error unused
class InheritingClass extends $BaseClass implements $BaseInterface<number>, $BaseInterface2 { class InheritingClass extends $BaseClass implements $BaseInterface<number>, $BaseInterface2 {
bar: string = ''; bar: string = '';

View File

@@ -16,7 +16,6 @@
import {EasyAstSpecType} from '../easy-ast-spec-type.js'; import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
// @ts-expect-error unused
interface NestedObject { interface NestedObject {
nested: { nested: {
deeplyNested: { deeplyNested: {

View File

@@ -17,7 +17,6 @@ import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
import {TypeFlags} from 'typescript'; import {TypeFlags} from 'typescript';
// @ts-expect-error unused
interface Test { interface Test {
number_type: number; number_type: number;
string_type: string; string_type: string;

View File

@@ -16,7 +16,6 @@
import {EasyAstSpecType} from '../easy-ast-spec-type.js'; import {EasyAstSpecType} from '../easy-ast-spec-type.js';
import {LightweightDefinitionKind} from '../../src/index.js'; import {LightweightDefinitionKind} from '../../src/index.js';
// @ts-expect-error unused
interface Foo<T extends Bar<string>> { interface Foo<T extends Bar<string>> {
bar: T; bar: T;
} }

6
pnpm-lock.yaml generated
View File

@@ -26,6 +26,9 @@ importers:
glob: glob:
specifier: 10.3.10 specifier: 10.3.10
version: 10.3.10 version: 10.3.10
http-server:
specifier: 14.1.1
version: 14.1.1
junit-report-merger: junit-report-merger:
specifier: 6.0.3 specifier: 6.0.3
version: 6.0.3 version: 6.0.3
@@ -11751,6 +11754,7 @@ packages:
peerDependenciesMeta: peerDependenciesMeta:
debug: debug:
optional: true optional: true
dev: false
/follow-redirects@1.15.6: /follow-redirects@1.15.6:
resolution: {integrity: sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==} resolution: {integrity: sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==}
@@ -12655,7 +12659,7 @@ packages:
engines: {node: '>=8.0.0'} engines: {node: '>=8.0.0'}
dependencies: dependencies:
eventemitter3: 4.0.7 eventemitter3: 4.0.7
follow-redirects: 1.15.3 follow-redirects: 1.15.6
requires-port: 1.0.0 requires-port: 1.0.0
transitivePeerDependencies: transitivePeerDependencies:
- debug - debug