@salesforce-ux/slds-linter 0.0.1

package/README.md

@@ -0,0 +1,74 @@
+# SDS Linter
+
+## Features
+
+* Component Linting:
+  The utility supports linting for two types of Salesforce Lightning components:
+
+  * LWC and Aura components.
+    LWC Components (.html): Linting is applied to Lightning Web Components.
+  * Aura Components (.cmp): Linting is applied to Aura Components.
+
+- Stylelint for CSS FilesStylelint rules are applied to .css files associated with the components. This ensures consistent styling practices are followed throughout the project.
+
+## Installation
+
+To install the SDS Linter Utility in your project, you can use npm:
+
+```
+npm install @salesforce-ux/sds-linter --save-dev
+```
+
+### Usage
+
+After installing the package, you need to add a few commands to your `package.json` to allow running the commands needed for linting.
+
+You need to add the below in "scripts" item in `package.json`
+
+```
+"lint:styles": "stylelint ./**/*.css --config=.stylelintrc.yml",
+"lint:components": "eslint ./**/*.{html,cmp} --ext .html,.cmp --config=.eslintrc.yml",
+"lint": "npm run lint:components; npm run lint:styles",
+"fix": "stylelint ./**/*.css -c .stylelintrc.yml --fix ",
+"report": "node node_modules/@salesforce-ux/stylelint-sds/build/report.js force-app/ -c .stylelintrc.yml",
+"setup-lint": "node ./node_modules/@salesforce-ux/sds-linter/build/setup.js"
+```
+
+once the above scripts are added. You can setup the configuration by running
+
+```
+npm run setup-lint
+```
+
+which will inturn create `.eslintrc.yml` & `.stylelintrc.yml` in the root folder.
+
+NOTE: If the project root already containing `.eslintrc.yml` & `.stylelintrc.yml`, we don't overwrite those files and the use needs to merge those files manually. You can find the configuration files in this repostory in the root folder.
+
+### Command-Line Interface (CLI)
+
+* To lint all components and styles in your project:
+
+  ```
+  npm run lint:components
+  npm run lint:styles
+  ```
+* To auto-fix some of the most confident fixes automatically.
+
+  ```
+  npm run fix
+  ```
+* To run a report in .sarif format
+
+  ```
+  npm run report
+  ```
+
+### Contribution
+
+We welcome contributions to improve this utility. If you have any suggestions, bug reports, or want to contribute code, please open an issue or pull request.
+
+### License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+For any questions or issues, feel free to reach out to the maintainers or open an issue in the repository.

package/build/.eslintrc.yml

@@ -0,0 +1,31 @@
+root: true
+env:
+  es2021: true
+  node: true
+parserOptions:
+  ecmaVersion: 2021
+  sourceType: module
+ignorePatterns:
+  - "node_modules/"
+overrides:
+  - files:
+      - "*.html"
+      - "*.cmp"
+    parser: "@html-eslint/parser"
+    plugins:
+      - "@salesforce-ux/sf-sds"
+    rules:
+      "@salesforce-ux/sf-sds/no-bem-class":
+        - "error"
+      "@salesforce-ux/sf-sds/no-deprecated-slds-classes":
+        - "error"
+
+  - files:
+      - "*.js"
+      - "*.json"
+    excludedFiles: "*.js"
+    rules:
+      "@salesforce-ux/no-bem-class":
+        - "error"
+      "@salesforce-ux/sf-sds/no-deprecated-slds-classes":
+        - "error"

package/build/.stylelintrc.yml

@@ -0,0 +1,52 @@
+plugins:
+  - "@salesforce-ux/stylelint-sds"
+
+overrides:
+  - files:
+      - "**/*.css"
+      - "**/*.scss"
+    customSyntax: "postcss"
+    rules:
+      sf-sds/no-slds-class-overrides:
+        - true
+        - severity: warning
+      sf-sds/no-important-tag:
+        - true
+        - severity: warning
+      # sf-sds/no-hardcoded-values:
+      #   - true
+      #   - severity: error
+      sf-sds/no-hardcoded-values-slds2:
+        - true
+        - severity: error
+      sf-sds/enforce-utility-classes:
+        - true
+      sf-sds/no-aura-tokens:
+        - true
+      sf-sds/lwc-to-slds-token:
+        - true
+      sf-sds/enforce-bem-usage:
+        - true
+      sf-sds/no-deprecated-slds-classes:
+        - true
+      sf-sds/no-deprecated-slds-hooks:
+        - true
+      sf-sds/no-lwc-custom-properties:
+        - true
+      sf-sds/no-sds-custom-properties:
+        - true
+      sf-sds/no-slds-private-var:
+        - true
+      # sf-sds/do-not-use-calc-function:
+      #   - true
+      sf-sds/enforce-sds-to-slds-hooks:
+        - true
+        - severity: error
+        
+    sourceMap: 
+      - false
+
+  - files:
+      - "**/*.html"
+    customSyntax: "postcss-html"
+    rules: {}

package/build/index.d.ts

@@ -0,0 +1 @@
+export declare function exampleFunction(filePath: string): string;

package/build/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/build/setup.js

@@ -0,0 +1,38 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+// Define __dirname for ES modules
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const config = [
+    {
+        "sourcePath": "./.eslintrc.yml",
+        "destinationPath": ".eslintrc.yml"
+    },
+    {
+        "sourcePath": "./.stylelintrc.yml",
+        "destinationPath": ".stylelintrc.yml"
+    }
+];
+function setupStylelintConfig() {
+    config.forEach(({ sourcePath, destinationPath }) => {
+        const source = path.resolve(__dirname, sourcePath);
+        const destination = path.resolve(process.cwd(), destinationPath);
+        // Check if the destination file already exists
+        if (!fs.existsSync(destination)) {
+            try {
+                // Copy the source file to the destination
+                fs.copyFileSync(source, destination);
+                console.log(`${destinationPath} has been successfully created.`);
+            }
+            catch (error) {
+                console.error(`Error copying ${destinationPath}:`, error);
+            }
+        }
+        else {
+            console.log(`${destinationPath} already exists. Merge configurations manually if needed.`);
+        }
+    });
+}
+setupStylelintConfig();

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@salesforce-ux/slds-linter",
+    "version": "0.0.1",
+    "description": "SLDS Linter with both stylelint and eslint together",
+    "main": "index.mjs",
+    "workspaces": [
+        "packages/*"
+    ],
+    "access": "public",
+    "files": [
+        "build/",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "rollup --config rollup.config.js",
+        "setup-lint": "node ./build/setup.js"
+    },
+    "type": "module",
+    "dependencies": {
+        "@salesforce-ux/eslint-plugin-sf-sds": "latest",
+        "@salesforce-ux/stylelint-sds": "latest"
+    },
+    "keywords": [
+        "eslint SDS",
+        "stylelint SDS",
+        "salesforce",
+        "sds linter"
+    ],
+    "author": "Kishore Nemalipuri",
+    "license": "MIT",
+    "devDependencies": {
+        "@rollup/plugin-typescript": "^12.1.2"
+    }
+}