@orion.ui/orion-linter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Orion UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# @orion.ui/orion-linter
+
+Shared linting configurations and custom rules for Orion UI projects. This package provides a unified code style guide using ESLint (with custom TypeScript and Vue rules) and Stylelint.
+
+## Features
+
+- **ESLint**:
+  - TypeScript support
+  - Vue.js 3 support
+  - Stylistic rules
+  - Custom rules for Orion architecture patterns
+- **Stylelint**:
+  - LESS support
+  - BEM naming convention
+  - Property ordering (clean order)
+  - Unit filtering
+
+## Installation
+
+Install the package and its peer dependencies:
+
+```bash
+npm install -D @orion.ui/orion-linter eslint stylelint typescript
+```
+
+## Usage
+
+### ESLint Configuration
+
+Create an `eslint.config.mjs` file in your project root:
+
+```javascript
+import { getESLintConfig } from '@orion.ui/orion-linter';
+export default await getESLintConfig();
+```
+
+OR
+
+```javascript
+import { getESLintConfig } from '@orion.ui/orion-linter';
+
+const orionConfig = await getESLintConfig();
+
+export default [
+  ...orionConfig,
+  {
+    // Your custom overrides here
+    rules: {
+      // ...
+    }
+  }
+];
+```
+
+### Stylelint Configuration
+
+Create a `stylelint.config.mjs` file in your project root:
+
+```javascript
+import { getStylelintConfig } from '@orion.ui/orion-linter';
+export default await getStylelintConfig();
+```
+
+OR
+
+```javascript
+import { getStylelintConfig } from '@orion.ui/orion-linter';
+
+const orionConfig = await getStylelintConfig();
+
+export default {
+  ...orionConfig,
+  rules: {
+    ...orionConfig.rules,
+    // Your custom overrides here
+  }
+};
+```
+
+## Custom ESLint Rules
+
+This package includes several custom rules designed to enforce architectural patterns within Orion projects. All rules are prefixed with `orion-rules/`.
+
+| Rule Name | Description |
+|-----------|-------------|
+| `async-suffix` | Enforces async functions to have an 'Async' suffix. |
+| `class-name-match-filename` | Ensures class names match their filenames. |
+| `default-props-are-static-readonly` | Enforces default props to be static readonly. |
+| `events-are-in-camel-case` | Enforces event names to be in camelCase. |
+| `force-dynamic-vue-imports-in-router` | Requires dynamic imports for Vue components in router files. |
+| `force-dynamic-vue-imports-in-services` | Requires dynamic imports for Vue components in services. |
+| `get-set-adjacent` | Enforces getters and setters to be defined adjacently. |
+| `get-set-one-liner` | Enforces simple getters and setters to be on a single line. |
+| `no-api-in-entity` | Prevents API usage inside Entity classes. |
+| `no-api-in-setup` | Prevents API usage inside Vue setup functions (use services instead). |
+| `no-entity-in-service` | Prevents Entity usage inside Service classes. |
+| `no-export-type-in-ts` | Disallows exporting types in `.ts` files (prefer `.d.ts` files). |
+| `popables-are-readonly` | Enforces "popable" properties to be readonly. |
+| `private-property-if-only-in-template` | Ensures properties not used in the template are marked as private. |
+| `state-are-private-readonly` | Enforces state properties to be private and readonly. |
+| `template-refs-are-readonly` | Enforces template refs to be readonly. |
+
+## Requirements
+
+- Node.js >= 18.12.0
+- ESLint >= 9.0.0
+- Stylelint >= 16.0.0
+- TypeScript >= 5.0.0
+
+## License
+
+MIT

package/dist/configs/eslint.config.mjs

@@ -0,0 +1,256 @@
+import eslintStylistic from '@stylistic/eslint-plugin';
+import tsEslintPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import eslintVue from 'eslint-plugin-vue';
+import asyncSuffix from '../rules/async-suffix.js';
+import classNameMatchFilename from '../rules/class-name-match-filename.js';
+import defaultPropsAreStaticReadonly from '../rules/default-props-are-static-readonly.js';
+import eventAreInCamelCase from '../rules/events-are-in-camel-case.js';
+import forceDynamicVueImportsInRouter from '../rules/force-dynamic-vue-imports-in-router.js';
+import forceDynamicVueImportsInServices from '../rules/force-dynamic-vue-imports-in-services.js';
+import getSetAdjacent from '../rules/get-set-adjacent.js';
+import getSetOneLiner from '../rules/get-set-one-liner.js';
+import noApiInEntity from '../rules/no-api-in-entity.js';
+import noApiInSetup from '../rules/no-api-in-setup.js';
+import noEntityInService from '../rules/no-entity-in-service.js';
+import noExportTypeInTs from '../rules/no-export-type-in-ts.js';
+import popablesAreReadonly from '../rules/popables-are-readonly.js';
+import privatePropertyIfOnlyInTemplate from '../rules/private-property-if-only-in-template.js';
+import stateArePrivateReadonly from '../rules/state-are-private-readonly.js';
+import templateRefsAreReadonly from '../rules/template-refs-are-readonly.js';
+
+// Common configuration for Orion plugins
+const orionRulesPlugin = {
+	'orion-rules': {
+		rules: {
+			'async-suffix': asyncSuffix,
+			'no-api-in-entity': noApiInEntity,
+			'no-api-in-setup': noApiInSetup,
+			'no-entity-in-service': noEntityInService,
+			'no-export-type-in-ts': noExportTypeInTs,
+			'template-refs-are-readonly': templateRefsAreReadonly,
+			'default-props-are-static-readonly': defaultPropsAreStaticReadonly,
+			'state-are-private-readonly': stateArePrivateReadonly,
+			'class-name-match-filename': classNameMatchFilename,
+			'popables-are-readonly': popablesAreReadonly,
+			'force-dynamic-vue-imports-in-services': forceDynamicVueImportsInServices,
+			'force-dynamic-vue-imports-in-router': forceDynamicVueImportsInRouter,
+			'get-set-one-liner': getSetOneLiner,
+			'get-set-adjacent': getSetAdjacent,
+			'events-are-in-camel-case': eventAreInCamelCase,
+			'private-property-if-only-in-template': privatePropertyIfOnlyInTemplate
+		},
+	},
+};
+
+const plugins = { ...orionRulesPlugin, '@typescript-eslint': tsEslintPlugin };
+
+export default [
+	eslintStylistic.configs['recommended'],
+	...eslintVue.configs['flat/recommended'],
+
+	{ ignores: ['src/typings/**/*.ts', 'src/assets'] },
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// TS & JS files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*.ts', '**/*.tsx'],
+		languageOptions: {
+			parser: tsParser,
+			parserOptions: { jsx: true },
+		},
+		plugins,
+	},
+	{
+		files: ['**/*.js', '**/*.jsx'],
+		languageOptions: { parserOptions: { jsx: true } },
+		plugins,
+	},
+	{
+		rules: {
+			'no-unused-vars': [ // Generic JS rule (disabled for TS below)
+				'warn', {
+					vars: 'all',
+					args: 'after-used',
+					caughtErrors: 'none',
+					argsIgnorePattern: '^(props|emits|_aside|_modal)$',
+				},
+			],
+			'eqeqeq': ['error', 'smart'],
+			'no-console': 'warn',
+			'no-debugger': 'error',
+			'no-restricted-exports': ['error', { 'restrictDefaultExports': { "direct": true } }],
+			'@stylistic/space-before-function-paren': ['error', 'always'],
+			'@stylistic/array-bracket-newline': ['error', { multiline: true }],
+			'@stylistic/no-tabs': 'off',
+			'@stylistic/quote-props': ['error', 'as-needed', { unnecessary: false }],
+			'@stylistic/indent': ['error', 'tab'],
+			'@stylistic/semi': ['error', 'always', { omitLastInOneLineBlock: true }],
+			'@stylistic/padded-blocks': ['error', { classes: 'always' }],
+			'@stylistic/object-curly-newline': [
+				'error', {
+					ObjectExpression: { multiline: true },
+					ObjectPattern: { multiline: true },
+					ImportDeclaration: 'never',
+					ExportDeclaration: { multiline: true },
+				},
+			],
+
+			// Custom local rules
+			'orion-rules/no-api-in-entity': 'error',
+			'orion-rules/no-api-in-setup': 'error',
+			'orion-rules/no-entity-in-service': 'error',
+			'orion-rules/no-export-type-in-ts': 'error',
+			'orion-rules/template-refs-are-readonly': 'error',
+			'orion-rules/default-props-are-static-readonly': 'error',
+			'orion-rules/state-are-private-readonly': 'error',
+			'orion-rules/class-name-match-filename': 'error',
+			'orion-rules/popables-are-readonly': 'error',
+			'orion-rules/async-suffix': 'error',
+			'orion-rules/get-set-one-liner': 'error',
+			'orion-rules/get-set-adjacent': 'error',
+			'orion-rules/events-are-in-camel-case': 'error',
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to TS files
+	// Specific TS override to replace core rule with one from typescript-eslint
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*.ts', '**/*.tsx'],
+		rules: {
+			'no-unused-vars': 'off',
+			'@stylistic/no-mixed-spaces-and-tabs':[ 'warn', 'smart-tabs'],
+			'@typescript-eslint/no-unused-vars': [
+				'warn', {
+					vars: 'all',
+					args: 'after-used',
+					caughtErrors: 'none',
+					ignoreRestSiblings: true,
+					// Important: named parameters in type signatures (function types, constructors, etc.)
+					// will not be considered runtime variables by the TS version of the rule,
+					// thus removing the cited false positives (ex: (...args: any[]) in a type / callback / constructor signature).
+				},
+			],
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to router files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/router/*.ts'],
+		plugins,
+		rules: {
+			'orion-rules/force-dynamic-vue-imports-in-router': 'error',
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to *Service.ts and *Setup.ts files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*Service.ts', '**/*Setup.ts'],
+		plugins,
+		rules: {
+			'orion-rules/force-dynamic-vue-imports-in-services': 'error',
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to d.ts files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*.d.ts'],
+		rules: {
+			'no-unused-vars': 'off',
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to Vue files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*.vue'],
+		languageOptions: { parserOptions: { parser: tsParser } },
+		plugins,
+		rules: {
+			'no-unused-vars': [
+				'warn', {
+					vars: 'all',
+					args: 'after-used',
+					caughtErrors: 'all',
+					varsIgnorePattern: '^setup$',
+				},
+			],
+			'vue/comma-dangle': ['error', 'always-multiline'],
+			'vue/comma-spacing': ['error', { before: false, after: true }],
+			'vue/object-curly-spacing': ['error', 'always'],
+			'vue/component-name-in-template-casing': ['error', 'kebab-case'],
+			'vue/no-v-html': 'off',
+			'vue/html-indent': [
+				'error',
+				'tab',
+				{
+					attribute: 1,
+					baseIndent: 1,
+					closeBracket: 0,
+					alignAttributesVertically: true,
+					ignores: [],
+				},
+			],
+			'vue/first-attribute-linebreak': [
+				'error', {
+					singleline: 'beside',
+					multiline: 'below',
+				},
+			],
+			'vue/html-closing-bracket-newline': [
+				'error',
+				{
+					singleline: 'never',
+					multiline: 'never',
+				},
+			],
+			'vue/html-closing-bracket-spacing': [
+				'error',
+				{
+					startTag: 'never',
+					endTag: 'never',
+					selfClosingTag: 'never',
+				},
+			],
+			'vue/singleline-html-element-content-newline': [
+				'error',
+				{
+					ignoreWhenNoAttributes: true,
+					ignoreWhenEmpty: true,
+					ignores: ['pre', 'textarea', 'div'],
+				},
+			],
+			'vue/space-infix-ops': process.env.NODE_ENV !== 'development'
+				? 'off'
+				: ['error', { int32Hint: false }],
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific to *SetupService.ts and *Setup.ts files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*SetupService.ts', '**/*Setup.ts'],
+		rules: {
+			'orion-rules/private-property-if-only-in-template': 'error',
+		},
+	},
+
+	// —————————————————————————————————————————————————————————————————————————————
+	// Rules specific for *.config.(ts|js|mjs) files
+	// —————————————————————————————————————————————————————————————————————————————
+	{
+		files: ['**/*.config.ts', '**/*.config.js', 'eslint.config.mjs'],
+		rules: { 'no-restricted-exports': 'off' },
+	},
+];

package/dist/configs/stylelint.config.mjs

@@ -0,0 +1,78 @@
+import { propertyGroups } from 'stylelint-config-clean-order';
+
+const propertiesOrder = propertyGroups.map(properties => ({
+	noEmptyLineBetween: true,
+	emptyLineBefore: 'never', // Don't add empty lines between order groups.
+	properties,
+}));
+
+/** @type {import('stylelint').Config} */
+export default {
+	ignoreFiles: [
+		'src/assets/**/*',
+		'src/**/*.ts',
+		'src/Dockerfile',
+	],
+
+	extends: [
+		'stylelint-config-standard-less',
+		'stylelint-config-recommended-vue',
+		'@stylistic/stylelint-config',
+		'stylelint-config-clean-order',
+	],
+
+	rules: {
+		'@stylistic/max-line-length': null,
+		'@stylistic/indentation': 'tab',
+
+		'less/no-duplicate-variables': null,
+
+		'media-query-no-invalid': null,
+		'declaration-block-no-duplicate-properties': [true, { ignore: ['consecutive-duplicates'] }],
+		'unit-allowed-list': ['px', 'rem', 'em', 'fr', '%', 's', 'deg', 'dvh', 'vh', 'dvw', 'vw'],
+		'declaration-property-unit-allowed-list': {
+			'/^font-size$/': ['rem', 'em'],
+			'/^(((row|column)-)?gap|(padding|margin)(-[a-z]+)?)$/': ['rem'],
+			'/^(max-)?(width|height)$/': ['rem', 'dvh', 'vh', 'dvw', 'vw', '%'],
+			'/^flex(-basis)?$/': ['%', 'rem'],
+		},
+		"declaration-block-no-redundant-longhand-properties": [true, { "ignoreShorthands": ["grid-template"] }],
+		'order/properties-order': [
+			propertiesOrder,
+			{
+				severity: 'warning',
+				unspecified: 'bottomAlphabetical',
+			},
+		],
+
+		'selector-class-pattern': [ // BEM naming convention
+			'^[a-z]([-]?[a-z0-9]+)*(__[a-z0-9]([-]?[a-z0-9]+)*)?(--[a-z0-9]([-]?[a-z0-9]+)*)?$',
+			{
+				/**
+         * Resolve nested selectors with & interpolation.
+         * https://stylelint.io/user-guide/rules/selector-class-pattern/#resolvenestedselectors-true--false-default-false
+         * */
+				resolveNestedSelectors: true,
+				message: function expected (selectorValue) {
+					return `Expected class selector "${selectorValue}" to match BEM CSS pattern https://en.bem.info/methodology/css. Selector validation tool: https://regexr.com/3apms`;
+				},
+			},
+		],
+	},
+
+	overrides: [
+		{
+			files: ['**/*.vue'],
+			customSyntax: 'postcss-html',
+			rules: {
+				'block-no-empty': null,
+				'no-empty-source': null, // Allow empty sources in Vue files
+			},
+		},
+		{
+			files: ['**/*.less'],
+			customSyntax: 'postcss-less',
+			rules: { '@stylistic/indentation': 'tab' },
+		},
+	],
+};

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+export * from './types.js';
+export * from './utils.js';
+/**
+ * Get the path to the ESLint configuration file
+ * @returns Absolute path to eslint.config.mjs (ESM module)
+ */
+export declare function getESLintConfigPath(): string;
+/**
+ * Get the path to the Stylelint configuration file
+ * @returns Absolute path to stylelint.config.mjs (ESM module)
+ */
+export declare function getStylelintConfigPath(): string;
+/**
+ * Import and return the ESLint configuration object
+ * @returns ESLint configuration object
+ */
+export declare function getESLintConfig(): Promise<any>;
+/**
+ * Import and return the Stylelint configuration object
+ * @returns Stylelint configuration object
+ */
+export declare function getStylelintConfig(): Promise<any>;
+export declare const paths: {
+    eslintConfig: string;
+    stylelintConfig: string;
+};
+export declare const configs: {
+    getESLintConfig: typeof getESLintConfig;
+    getStylelintConfig: typeof getStylelintConfig;
+};
+declare const _default: {
+    paths: {
+        eslintConfig: string;
+        stylelintConfig: string;
+    };
+    configs: {
+        getESLintConfig: typeof getESLintConfig;
+        getStylelintConfig: typeof getStylelintConfig;
+    };
+    getESLintConfigPath: typeof getESLintConfigPath;
+    getStylelintConfigPath: typeof getStylelintConfigPath;
+    getESLintConfig: typeof getESLintConfig;
+    getStylelintConfig: typeof getStylelintConfig;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,75 @@
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+// ESM equivalent of __dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+// Export types and utilities
+export * from './types.js';
+export * from './utils.js';
+/**
+ * Get the path to the ESLint configuration file
+ * @returns Absolute path to eslint.config.mjs (ESM module)
+ */
+export function getESLintConfigPath() {
+    return resolve(__dirname, './configs/eslint.config.mjs');
+}
+/**
+ * Get the path to the Stylelint configuration file
+ * @returns Absolute path to stylelint.config.mjs (ESM module)
+ */
+export function getStylelintConfigPath() {
+    return resolve(__dirname, './configs/stylelint.config.mjs');
+}
+/**
+ * Import and return the ESLint configuration object
+ * @returns ESLint configuration object
+ */
+export async function getESLintConfig() {
+    const configPath = getESLintConfigPath();
+    try {
+        // Convert Windows path to file:// URL for ESM compatibility
+        const configUrl = pathToFileURL(configPath).href;
+        // Use dynamic import for ESM modules
+        const config = await import(configUrl);
+        return config.default || config;
+    }
+    catch (error) {
+        throw new Error(`Failed to load ESLint configuration from ${configPath}: ${error}`);
+    }
+}
+/**
+ * Import and return the Stylelint configuration object
+ * @returns Stylelint configuration object
+ */
+export async function getStylelintConfig() {
+    const configPath = getStylelintConfigPath();
+    try {
+        // Convert Windows path to file:// URL for ESM compatibility
+        const configUrl = pathToFileURL(configPath).href;
+        // Use dynamic import for ESM modules
+        const config = await import(configUrl);
+        return config.default || config;
+    }
+    catch (error) {
+        throw new Error(`Failed to load Stylelint configuration from ${configPath}: ${error}`);
+    }
+}
+// Export paths for direct usage
+export const paths = {
+    eslintConfig: getESLintConfigPath(),
+    stylelintConfig: getStylelintConfigPath(),
+};
+// Export configuration objects for direct usage
+export const configs = {
+    getESLintConfig: getESLintConfig,
+    getStylelintConfig: getStylelintConfig,
+};
+// Default export for convenience
+export default {
+    paths,
+    configs,
+    getESLintConfigPath,
+    getStylelintConfigPath,
+    getESLintConfig,
+    getStylelintConfig,
+};