@accordproject/concerto-linter 1.0.0

package/test/unit/formatResults.test.ts

@@ -0,0 +1,149 @@
+// tests/unit/index.test.ts
+import { jest } from '@jest/globals';
+import { lintModel } from '../../src/index';
+import * as configLoader from '../../src/config-loader';
+
+// Only mock our own functions when needed
+jest.mock('../../src/config-loader');
+
+const mockedConfigLoader = configLoader as jest.Mocked<typeof configLoader>;
+
+
+describe('formatResults', () => {
+    test('should format spectral results correctly', async () => {
+    // Create a model that will likely trigger some linting results
+        const modelWithIssues = `
+      namespace com.example
+      
+      concept class {  // 'class' is a reserved keyword
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(modelWithIssues, {
+            ruleset: 'default',
+            excludeNamespaces: [] // Don't exclude anything to see all results
+        });
+
+        if (results.length > 0) {
+            const result = results[0];
+            expect(result).toHaveProperty('code');
+            expect(result).toHaveProperty('message');
+            expect(result).toHaveProperty('severity');
+            expect(result).toHaveProperty('path');
+            expect(result).toHaveProperty('namespace');
+            expect(typeof result.code).toBe('string');
+            expect(typeof result.message).toBe('string');
+            expect(['error', 'warning', 'info', 'hint']).toContain(result.severity);
+            expect(Array.isArray(result.path)).toBe(true);
+            expect(typeof result.namespace).toBe('string');
+        }
+    });
+
+    test('should exclude specified namespaces', async () => {
+        const modelWithMultipleNamespaces = `
+      namespace concerto.test
+      
+      concept TestConcept {
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(modelWithMultipleNamespaces, {
+            ruleset: 'default',
+            excludeNamespaces: ['concerto.*']
+        });
+
+        // All results should be filtered out due to namespace exclusion
+        results.forEach(result => {
+            expect(result.namespace).not.toMatch(/^concerto\./);
+        });
+    });
+
+    test('should handle wildcard exclusion patterns', async () => {
+        const model = `
+      namespace org.accordproject.test
+      
+      concept TestConcept {
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(model, {
+            ruleset: 'default',
+            excludeNamespaces: ['org.accordproject.*']
+        });
+
+        results.forEach(result => {
+            expect(result.namespace).not.toMatch(/^org\.accordproject\./);
+        });
+    });
+
+    test('should handle exact namespace exclusion', async () => {
+        const model = `
+      namespace exact.match
+      
+      concept TestConcept {
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(model, {
+            ruleset: 'default',
+            excludeNamespaces: ['exact.match']
+        });
+
+        results.forEach(result => {
+            expect(result.namespace).not.toBe('exact.match');
+        });
+    });
+
+    test('should handle string exclusion pattern', async () => {
+        const model = `
+      namespace test.namespace
+      
+      concept TestConcept {
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(model, {
+            ruleset: 'default',
+            excludeNamespaces: 'test.*'
+        });
+
+        results.forEach(result => {
+            expect(result.namespace).not.toMatch(/^test\./);
+        });
+    });
+
+    test('should use default exclusion patterns when none specified', async () => {
+        const concertoModel = `
+      namespace concerto.test
+      
+      concept TestConcept {
+        o String value
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(concertoModel, { ruleset: 'default' });
+
+        // Default exclusions should filter out concerto.* namespaces
+        results.forEach(result => {
+            expect(result.namespace).not.toMatch(/^concerto\./);
+            expect(result.namespace).not.toMatch(/^org\.accordproject\./);
+        });
+    });
+});

package/test/unit/lintModel.test.ts

@@ -0,0 +1,84 @@
+// tests/unit/index.test.ts
+import { jest } from '@jest/globals';
+import { lintModel } from '../../src/index';
+import * as configLoader from '../../src/config-loader';
+
+// Only mock our own functions when needed
+jest.mock('../../src/config-loader');
+
+const mockedConfigLoader = configLoader as jest.Mocked<typeof configLoader>;
+
+describe('lintModel', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+
+    test('should lint a valid model successfully', async () => {
+        const validModel = `
+      namespace com.example
+
+      concept Person {
+        o String firstName
+        o String lastName
+        o Integer age
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const result = await lintModel(validModel, { ruleset: 'default' });
+
+        expect(Array.isArray(result)).toBe(true);
+    // A valid model might still have some warnings, but shouldn't throw errors
+    });
+
+    test('should detect violations in problematic model', async () => {
+        const problematicModel = `
+      namespace com.example
+
+      concept class {  // Reserved keyword as concept name
+        o String private  // Reserved keyword as property name
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const results = await lintModel(problematicModel, {
+            ruleset: 'default',
+            excludeNamespaces: []
+        });
+
+        // Should detect at least some violations
+        expect(Array.isArray(results)).toBe(true);
+    });
+
+    test('should handle malformed model', async () => {
+        const malformedModel = 'namespace invalid syntax }}}';
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        await expect(lintModel(malformedModel)).rejects.toThrow('Linting process failed');
+    });
+
+    test('should work with all configuration options', async () => {
+        const model = `
+      namespace com.example.test
+
+      concept ValidConcept {
+        o String validProperty
+      }
+    `;
+
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const config = {
+            ruleset: 'default',
+            excludeNamespaces: ['concerto.*', 'org.accordproject.*']
+        };
+
+        const results = await lintModel(model, config);
+
+        expect(Array.isArray(results)).toBe(true);
+    });
+
+});

package/test/unit/loadRuleset.test.ts

@@ -0,0 +1,64 @@
+import { jest } from '@jest/globals';
+import { lintModel } from '../../src/index';
+import * as configLoader from '../../src/config-loader';
+
+jest.mock('../../src/config-loader');
+
+const mockedConfigLoader = configLoader as jest.Mocked<typeof configLoader>;
+
+describe('loadRuleset', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+
+    test('should use default ruleset when "default" is specified', async () => {
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const validModel = `
+      namespace com.example
+      concept Test {
+        o String value
+      }
+    `;
+
+        const result = await lintModel(validModel, { ruleset: 'default' });
+        expect(Array.isArray(result)).toBe(true);
+        expect(mockedConfigLoader.resolveRulesetPath).not.toHaveBeenCalled();
+    });
+
+    test('should handle custom ruleset path', async () => {
+        const customRulesetPath = '/path/to/custom/ruleset.yaml';
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(customRulesetPath);
+
+        const validModel = `
+      namespace com.example
+      concept Test {
+        o String value
+      }
+    `;
+
+        // This will fail in actual execution due to non-existent file,
+        // but we can test that the path resolution is called correctly
+        try {
+            await lintModel(validModel, { ruleset: customRulesetPath });
+        } catch {
+            // Expected to fail since file doesn't exist
+            expect(mockedConfigLoader.resolveRulesetPath).toHaveBeenCalledWith(customRulesetPath);
+        }
+    });
+
+    test('should handle undefined ruleset (use auto-discovery)', async () => {
+        mockedConfigLoader.resolveRulesetPath.mockResolvedValue(null);
+
+        const validModel = `
+      namespace com.example
+      concept Test {
+        o String value
+      }
+    `;
+
+        const result = await lintModel(validModel);
+        expect(Array.isArray(result)).toBe(true);
+        expect(mockedConfigLoader.resolveRulesetPath).toHaveBeenCalledWith(undefined);
+    });
+});

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "dist", "**/*spec.ts", "test"]
+}

package/tsconfig.json

@@ -0,0 +1,113 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "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. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "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. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"], // Include all your source .ts and .d.ts files
+  "exclude": ["node_modules", "dist"] // Exclude node_modules and the output folder from general checking
+}