@accordproject/concerto-linter 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +20 -0
- package/.eslintrc.yml +45 -0
- package/HEADER.md +2 -0
- package/README.md +207 -0
- package/default-ruleset/.eslintignore +20 -0
- package/default-ruleset/.eslintrc.yml +45 -0
- package/default-ruleset/README.md +300 -0
- package/default-ruleset/jest.config.js +7 -0
- package/default-ruleset/package.json +51 -0
- package/default-ruleset/src/abstract-must-subclassed.ts +29 -0
- package/default-ruleset/src/camel-case-properties.ts +35 -0
- package/default-ruleset/src/functions/check-length-validator.ts +52 -0
- package/default-ruleset/src/functions/find-abstract-declaration.ts +70 -0
- package/default-ruleset/src/functions/find-empty-declarations.ts +56 -0
- package/default-ruleset/src/namespace-version.ts +35 -0
- package/default-ruleset/src/no-empty-declarations.ts +31 -0
- package/default-ruleset/src/no-reserved-keywords.ts +43 -0
- package/default-ruleset/src/pascal-case-declarations.ts +35 -0
- package/default-ruleset/src/pascal-case-decorators.ts +38 -0
- package/default-ruleset/src/ruleset-main.ts +41 -0
- package/default-ruleset/src/string-length-validator.ts +32 -0
- package/default-ruleset/src/upper-snake-case-enum-const.ts +36 -0
- package/default-ruleset/test/fixtures/ENUM_Constans-invaild.cto +7 -0
- package/default-ruleset/test/fixtures/ENUM_Constans-vaild.cto +7 -0
- package/default-ruleset/test/fixtures/abstract-must-subclassed-invalid.cto +10 -0
- package/default-ruleset/test/fixtures/abstract-must-subclassed-valid.cto +18 -0
- package/default-ruleset/test/fixtures/declarations-valid-PascalCase.cto +21 -0
- package/default-ruleset/test/fixtures/declarations-violate-PascalCase.cto +22 -0
- package/default-ruleset/test/fixtures/decorators-valid-PascalCase.cto +8 -0
- package/default-ruleset/test/fixtures/decorators-violate-PascalCase.cto +8 -0
- package/default-ruleset/test/fixtures/namespace-invalid-version.cto +5 -0
- package/default-ruleset/test/fixtures/namespace-valid-version.cto +5 -0
- package/default-ruleset/test/fixtures/no-empty-declarations-invalid.cto +10 -0
- package/default-ruleset/test/fixtures/no-empty-declarations-valid.cto +16 -0
- package/default-ruleset/test/fixtures/no-reserved-keywords-invalid.cto +16 -0
- package/default-ruleset/test/fixtures/no-reserved-keywords-valid.cto +16 -0
- package/default-ruleset/test/fixtures/properties-valid-camelCase.cto +10 -0
- package/default-ruleset/test/fixtures/properties-violate-camelCase.cto +10 -0
- package/default-ruleset/test/fixtures/string-length-validator-invalid.cto +9 -0
- package/default-ruleset/test/fixtures/string-length-validator-valid.cto +10 -0
- package/default-ruleset/test/rules/abstract-must-subclassed.test.ts +33 -0
- package/default-ruleset/test/rules/namespace-version.test.ts +24 -0
- package/default-ruleset/test/rules/naming-ruleset.test.ts +133 -0
- package/default-ruleset/test/rules/no-empty-declarations.test.ts +33 -0
- package/default-ruleset/test/rules/no-reserved-keywords.test.ts +33 -0
- package/default-ruleset/test/rules/string-length-validator.test.ts +33 -0
- package/default-ruleset/test/test-rule.ts +30 -0
- package/default-ruleset/tsconfig.json +113 -0
- package/dist/config-loader.d.ts +6 -0
- package/dist/config-loader.js +52 -0
- package/dist/config-loader.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.js +135 -0
- package/dist/index.js.map +1 -0
- package/jest.config.js +11 -0
- package/package.json +54 -0
- package/src/config-loader.ts +48 -0
- package/src/index.ts +173 -0
- package/test/unit/configLoader.test.ts +76 -0
- package/test/unit/formatResults.test.ts +149 -0
- package/test/unit/lintModel.test.ts +84 -0
- package/test/unit/loadRuleset.test.ts +64 -0
- package/tsconfig.build.json +4 -0
- package/tsconfig.json +113 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
namespace org.example@1.0.0
|
|
2
|
+
|
|
3
|
+
scalar ssnNumber extends String default="000-00-0000"
|
|
4
|
+
|
|
5
|
+
concept myProduct {
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
asset pAYmentOrder {
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
participant customer {
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
transaction order {
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
event lateDelivery{
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
enum product {
|
|
21
|
+
|
|
22
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import abstractMustSubclassed from '../../src/abstract-must-subclassed';
|
|
3
|
+
|
|
4
|
+
describe('Abstract Must Be Subclassed Rule', () => {
|
|
5
|
+
test('should not report any violations when all abstract declarations have concrete subclasses', async () => {
|
|
6
|
+
const results = await testRules({
|
|
7
|
+
rules: {
|
|
8
|
+
'abstract-must-subclassed': abstractMustSubclassed,
|
|
9
|
+
}
|
|
10
|
+
}, 'abstract-must-subclassed-valid.cto');
|
|
11
|
+
expect(results).toHaveLength(0);
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
test('should report violations when abstract declarations have no concrete subclasses', async () => {
|
|
15
|
+
const results = await testRules({
|
|
16
|
+
rules: {
|
|
17
|
+
'abstract-must-subclassed': abstractMustSubclassed,
|
|
18
|
+
}
|
|
19
|
+
}, 'abstract-must-subclassed-invalid.cto');
|
|
20
|
+
|
|
21
|
+
// We expect multiple violations - one for each abstract declaration without concrete subclass
|
|
22
|
+
expect(results.length).toBeGreaterThan(0);
|
|
23
|
+
|
|
24
|
+
// Check that the rule code is correct
|
|
25
|
+
results.forEach(result => {
|
|
26
|
+
expect(result.code).toBe('abstract-must-subclassed');
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Check that the message contains the expected text
|
|
30
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
31
|
+
expect(messageText).toContain('must have concrete subclasses');
|
|
32
|
+
});
|
|
33
|
+
});
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import namespaceVersion from '../../src/namespace-version';
|
|
3
|
+
|
|
4
|
+
describe('Namespace Version Rule', () => {
|
|
5
|
+
test('should not report any violations for namespaces with valid version', async () => {
|
|
6
|
+
const results = await testRules({
|
|
7
|
+
rules: {
|
|
8
|
+
'namespace-version': namespaceVersion,
|
|
9
|
+
}
|
|
10
|
+
}, 'namespace-valid-version.cto');
|
|
11
|
+
expect(results).toHaveLength(0);
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
test('should report a violation for namespaces without version', async () => {
|
|
15
|
+
const results = await testRules({
|
|
16
|
+
rules: {
|
|
17
|
+
'namespace-version': namespaceVersion,
|
|
18
|
+
}
|
|
19
|
+
}, 'namespace-invalid-version.cto');
|
|
20
|
+
expect(results).toHaveLength(1);
|
|
21
|
+
expect(results[0].code).toBe('namespace-version');
|
|
22
|
+
expect(results[0].message).toContain('should specify a version');
|
|
23
|
+
});
|
|
24
|
+
});
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import pascalCaseDeclarations from '../../src/pascal-case-declarations';
|
|
3
|
+
import camelCaseProperties from '../../src/camel-case-properties';
|
|
4
|
+
import upperSnakeCaseEnumConst from '../../src/upper-snake-case-enum-const';
|
|
5
|
+
import pascalCaseDecorators from '../../src/pascal-case-decorators';
|
|
6
|
+
|
|
7
|
+
describe('PascalCase Declarations Rule', () => {
|
|
8
|
+
test('should not report any violations for correctly named declarations', async () => {
|
|
9
|
+
const results = await testRules({
|
|
10
|
+
rules: {
|
|
11
|
+
'pascal-case-declarations': pascalCaseDeclarations,
|
|
12
|
+
}
|
|
13
|
+
}, 'declarations-valid-PascalCase.cto');
|
|
14
|
+
expect(results).toHaveLength(0);
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
test('should report violations for invalid declaration names', async () => {
|
|
18
|
+
const results = await testRules({
|
|
19
|
+
rules: {
|
|
20
|
+
'pascal-case-declarations': pascalCaseDeclarations,
|
|
21
|
+
}
|
|
22
|
+
}, 'declarations-violate-PascalCase.cto');
|
|
23
|
+
|
|
24
|
+
// Check that we have the expected number of violations
|
|
25
|
+
expect(results.length).toBeGreaterThan(0);
|
|
26
|
+
expect(results).toHaveLength(7);
|
|
27
|
+
|
|
28
|
+
// Check that the rule code is correct
|
|
29
|
+
results.forEach(result => {
|
|
30
|
+
expect(result.code).toBe('pascal-case-declarations');
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// Check that the message contains the expected text
|
|
34
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
35
|
+
expect(messageText).toContain('should be PascalCase');
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
describe('CamelCase Properties Rule', () => {
|
|
40
|
+
test('should not report any violations for correctly named properties', async () => {
|
|
41
|
+
const results = await testRules({
|
|
42
|
+
rules: {
|
|
43
|
+
'camel-case-properties': camelCaseProperties,
|
|
44
|
+
}
|
|
45
|
+
}, 'properties-valid-camelCase.cto');
|
|
46
|
+
expect(results).toHaveLength(0);
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
test('should report violations for invalid property names', async () => {
|
|
50
|
+
const results = await testRules({
|
|
51
|
+
rules: {
|
|
52
|
+
'camel-case-properties': camelCaseProperties,
|
|
53
|
+
}
|
|
54
|
+
}, 'properties-violate-camelCase.cto');
|
|
55
|
+
|
|
56
|
+
// Check that we have the expected number of violations
|
|
57
|
+
expect(results.length).toBeGreaterThan(0);
|
|
58
|
+
expect(results).toHaveLength(6);
|
|
59
|
+
|
|
60
|
+
// Check that the rule code is correct
|
|
61
|
+
results.forEach(result => {
|
|
62
|
+
expect(result.code).toBe('camel-case-properties');
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
// Check that the message contains the expected text
|
|
66
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
67
|
+
expect(messageText).toContain('should be camelCase');
|
|
68
|
+
});
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
describe('UPPER_SNAKE_CASE Enum Constants Rule', () => {
|
|
72
|
+
test('should not report any violations for correctly named enum constants', async () => {
|
|
73
|
+
const results = await testRules({
|
|
74
|
+
rules: {
|
|
75
|
+
'upper-snake-case-enum-constants': upperSnakeCaseEnumConst,
|
|
76
|
+
}
|
|
77
|
+
}, 'ENUM_Constans-vaild.cto');
|
|
78
|
+
expect(results).toHaveLength(0);
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
test('should report violations for invalid enum constant names', async () => {
|
|
82
|
+
const results = await testRules({
|
|
83
|
+
rules: {
|
|
84
|
+
'upper-snake-case-enum-constants': upperSnakeCaseEnumConst,
|
|
85
|
+
}
|
|
86
|
+
}, 'ENUM_Constans-invaild.cto');
|
|
87
|
+
|
|
88
|
+
// Check that we have the expected number of violations
|
|
89
|
+
expect(results.length).toBeGreaterThan(0);
|
|
90
|
+
expect(results).toHaveLength(3);
|
|
91
|
+
|
|
92
|
+
// Check that the rule code is correct
|
|
93
|
+
results.forEach(result => {
|
|
94
|
+
expect(result.code).toBe('upper-snake-case-enum-constants');
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
// Check that the message contains the expected text
|
|
98
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
99
|
+
expect(messageText).toContain('should be UPPER_SNAKE_CASE');
|
|
100
|
+
});
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
describe('PascalCase Decorators Rule', () => {
|
|
104
|
+
test('should not report any violations for correctly named decorators', async () => {
|
|
105
|
+
const results = await testRules({
|
|
106
|
+
rules: {
|
|
107
|
+
'pascal-case-decorators': pascalCaseDecorators,
|
|
108
|
+
}
|
|
109
|
+
}, 'decorators-valid-PascalCase.cto');
|
|
110
|
+
expect(results).toHaveLength(0);
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
test('should report violations for invalid decorator names', async () => {
|
|
114
|
+
const results = await testRules({
|
|
115
|
+
rules: {
|
|
116
|
+
'pascal-case-decorators': pascalCaseDecorators,
|
|
117
|
+
}
|
|
118
|
+
}, 'decorators-violate-PascalCase.cto');
|
|
119
|
+
|
|
120
|
+
// Check that we have the expected number of violations
|
|
121
|
+
expect(results.length).toBeGreaterThan(0);
|
|
122
|
+
expect(results).toHaveLength(3);
|
|
123
|
+
|
|
124
|
+
// Check that the rule code is correct
|
|
125
|
+
results.forEach(result => {
|
|
126
|
+
expect(result.code).toBe('pascal-case-decorators');
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
// Check that the message contains the expected text
|
|
130
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
131
|
+
expect(messageText).toContain('should be PascalCase');
|
|
132
|
+
});
|
|
133
|
+
});
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import noEmptyDeclarations from '../../src/no-empty-declarations';
|
|
3
|
+
|
|
4
|
+
describe('No Empty Declarations Rule', () => {
|
|
5
|
+
test('should not report any violations when all declarations have properties', async () => {
|
|
6
|
+
const results = await testRules({
|
|
7
|
+
rules: {
|
|
8
|
+
'no-empty-declarations': noEmptyDeclarations,
|
|
9
|
+
}
|
|
10
|
+
}, 'no-empty-declarations-valid.cto');
|
|
11
|
+
expect(results).toHaveLength(0);
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
test('should report violations when declarations are empty', async () => {
|
|
15
|
+
const results = await testRules({
|
|
16
|
+
rules: {
|
|
17
|
+
'no-empty-declarations': noEmptyDeclarations,
|
|
18
|
+
}
|
|
19
|
+
}, 'no-empty-declarations-invalid.cto');
|
|
20
|
+
|
|
21
|
+
// We expect multiple violations - one for each empty declaration
|
|
22
|
+
expect(results.length).toBeGreaterThan(0);
|
|
23
|
+
|
|
24
|
+
// Check that the rule code is correct
|
|
25
|
+
results.forEach(result => {
|
|
26
|
+
expect(result.code).toBe('no-empty-declarations');
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Check that the message contains the expected text
|
|
30
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
31
|
+
expect(messageText).toContain('should not be empty');
|
|
32
|
+
});
|
|
33
|
+
});
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import noReservedKeywords from '../../src/no-reserved-keywords';
|
|
3
|
+
|
|
4
|
+
describe('No Reserved Keywords Rule', () => {
|
|
5
|
+
test('should not report any violations when no reserved keywords are used', async () => {
|
|
6
|
+
const results = await testRules({
|
|
7
|
+
rules: {
|
|
8
|
+
'no-reserved-keywords': noReservedKeywords,
|
|
9
|
+
}
|
|
10
|
+
}, 'no-reserved-keywords-valid.cto');
|
|
11
|
+
expect(results).toHaveLength(0);
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
test('should report violations when reserved keywords are used', async () => {
|
|
15
|
+
const results = await testRules({
|
|
16
|
+
rules: {
|
|
17
|
+
'no-reserved-keywords': noReservedKeywords,
|
|
18
|
+
}
|
|
19
|
+
}, 'no-reserved-keywords-invalid.cto');
|
|
20
|
+
|
|
21
|
+
// We expect multiple violations - for declaration names and property names
|
|
22
|
+
expect(results.length).toBeGreaterThan(0);
|
|
23
|
+
|
|
24
|
+
// Check that the rule code is correct
|
|
25
|
+
results.forEach(result => {
|
|
26
|
+
expect(result.code).toBe('no-reserved-keywords');
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Check that the message contains the expected text
|
|
30
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
31
|
+
expect(messageText).toContain('is a reserved keyword');
|
|
32
|
+
});
|
|
33
|
+
});
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { testRules } from '../test-rule';
|
|
2
|
+
import stringLengthValidator from '../../src/string-length-validator';
|
|
3
|
+
|
|
4
|
+
describe('String Length Validator Rule', () => {
|
|
5
|
+
test('should not report any violations when all strings have length validators', async () => {
|
|
6
|
+
const results = await testRules({
|
|
7
|
+
rules: {
|
|
8
|
+
'string-length-validator': stringLengthValidator,
|
|
9
|
+
}
|
|
10
|
+
}, 'string-length-validator-valid.cto');
|
|
11
|
+
expect(results).toHaveLength(0);
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
test('should report violations when strings are missing length validators', async () => {
|
|
15
|
+
const results = await testRules({
|
|
16
|
+
rules: {
|
|
17
|
+
'string-length-validator': stringLengthValidator,
|
|
18
|
+
}
|
|
19
|
+
}, 'string-length-validator-invalid.cto');
|
|
20
|
+
|
|
21
|
+
// We expect multiple violations - one for each string without a length validator
|
|
22
|
+
expect(results.length).toBeGreaterThan(0);
|
|
23
|
+
|
|
24
|
+
// Check that the rule code is correct
|
|
25
|
+
results.forEach(result => {
|
|
26
|
+
expect(result.code).toBe('string-length-validator');
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
// Check that the message contains the expected text
|
|
30
|
+
const messageText = results.map(r => r.message).join(' ');
|
|
31
|
+
expect(messageText).toContain('must have a length validator');
|
|
32
|
+
});
|
|
33
|
+
});
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import * as fs from 'fs/promises';
|
|
2
|
+
import * as path from 'path';
|
|
3
|
+
import { Parser } from '@accordproject/concerto-cto';
|
|
4
|
+
import { Json as JsonParsers } from '@stoplight/spectral-parsers';
|
|
5
|
+
import { Spectral, Document, IRuleResult, RulesetDefinition } from '@stoplight/spectral-core';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Tests the Concerto linter's default ruleset.
|
|
9
|
+
* @param {RulesetDefinition} [ruleset] - Optional ruleset to apply for testing.
|
|
10
|
+
* @param {string} modelFile - The model (CTO string) to be linted.
|
|
11
|
+
Note: No external dependency resolution is performed.
|
|
12
|
+
* @returns {Promise<IRuleResult[]>} A promise that resolves to an array of linting results.
|
|
13
|
+
* @throws {Error} If a critical processing failure occurs during linting.
|
|
14
|
+
*/
|
|
15
|
+
export async function testRules(ruleset: RulesetDefinition, modelFile: string): Promise<IRuleResult[]> {
|
|
16
|
+
try {
|
|
17
|
+
const filePath = path.resolve(__dirname, './fixtures/', modelFile);
|
|
18
|
+
const model = await fs.readFile(filePath, 'utf-8');
|
|
19
|
+
|
|
20
|
+
const jsonAST = JSON.stringify(Parser.parseModels([model]));
|
|
21
|
+
|
|
22
|
+
const spectral = new Spectral();
|
|
23
|
+
spectral.setRuleset(ruleset);
|
|
24
|
+
|
|
25
|
+
const document = new Document(jsonAST, JsonParsers);
|
|
26
|
+
return await spectral.run(document);
|
|
27
|
+
} catch (error) {
|
|
28
|
+
throw new Error(`Failed to test the default-ruleset: ${error instanceof Error ? error.message : String(error)}`);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
/* Visit https://aka.ms/tsconfig to read more about this file */
|
|
4
|
+
|
|
5
|
+
/* Projects */
|
|
6
|
+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
|
7
|
+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
|
8
|
+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
|
9
|
+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
|
10
|
+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
|
11
|
+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
|
12
|
+
|
|
13
|
+
/* Language and Environment */
|
|
14
|
+
"target": "es2020", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
|
15
|
+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
|
16
|
+
// "jsx": "preserve", /* Specify what JSX code is generated. */
|
|
17
|
+
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
|
|
18
|
+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
|
19
|
+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
|
20
|
+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
|
21
|
+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
|
22
|
+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
|
23
|
+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
|
24
|
+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
|
25
|
+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
|
26
|
+
|
|
27
|
+
/* Modules */
|
|
28
|
+
"module": "commonjs", /* Specify what module code is generated. */
|
|
29
|
+
"rootDir": "./src", /* Specify the root folder within your source files. */
|
|
30
|
+
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
|
|
31
|
+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
|
32
|
+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
|
33
|
+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
|
34
|
+
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
|
35
|
+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
|
36
|
+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
|
37
|
+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
|
38
|
+
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
|
|
39
|
+
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
|
|
40
|
+
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
|
|
41
|
+
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
|
|
42
|
+
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
|
|
43
|
+
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
|
|
44
|
+
// "resolveJsonModule": true, /* Enable importing .json files. */
|
|
45
|
+
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
|
|
46
|
+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
|
47
|
+
|
|
48
|
+
/* JavaScript Support */
|
|
49
|
+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
|
50
|
+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
|
51
|
+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
|
52
|
+
|
|
53
|
+
/* Emit */
|
|
54
|
+
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
|
55
|
+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
|
56
|
+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
|
57
|
+
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
|
58
|
+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
|
59
|
+
// "noEmit": true, /* Disable emitting files from a compilation. */
|
|
60
|
+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
|
61
|
+
"outDir": "./dist", /* Specify an output folder for all emitted files. */
|
|
62
|
+
// "removeComments": true, /* Disable emitting comments. */
|
|
63
|
+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
|
64
|
+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
|
65
|
+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
|
66
|
+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
|
67
|
+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
|
68
|
+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
|
69
|
+
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
|
70
|
+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
|
71
|
+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
|
72
|
+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
|
73
|
+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
|
74
|
+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
|
75
|
+
|
|
76
|
+
/* Interop Constraints */
|
|
77
|
+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
|
78
|
+
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
|
|
79
|
+
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
|
|
80
|
+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
|
81
|
+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
|
82
|
+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
|
83
|
+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
|
84
|
+
|
|
85
|
+
/* Type Checking */
|
|
86
|
+
"strict": true, /* Enable all strict type-checking options. */
|
|
87
|
+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
|
88
|
+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
|
89
|
+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
|
90
|
+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
|
91
|
+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
|
92
|
+
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
|
|
93
|
+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
|
94
|
+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
|
95
|
+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
|
96
|
+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
|
97
|
+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
|
98
|
+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
|
99
|
+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
|
100
|
+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
|
101
|
+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
|
102
|
+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
|
103
|
+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
|
104
|
+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
|
105
|
+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
|
106
|
+
|
|
107
|
+
/* Completeness */
|
|
108
|
+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
|
109
|
+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
|
110
|
+
},
|
|
111
|
+
"include": ["src/**/*.ts", "src/**/*.d.ts"], // Include all your source .ts and .d.ts files
|
|
112
|
+
"exclude": ["node_modules", "dist"] // Exclude node_modules and the output folder from general checking
|
|
113
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolves the Spectral ruleset location based on user input or directory search
|
|
3
|
+
* @param {string} [customPath] User-provided ruleset path
|
|
4
|
+
* @returns {Promise<string | null>} Path to custom ruleset, null for default ruleset
|
|
5
|
+
*/
|
|
6
|
+
export declare function resolveRulesetPath(customPath?: string): Promise<string | null>;
|