@salesforce-ux/slds-linter 0.1.0 → 0.1.1

package/README.md

@@ -66,7 +66,7 @@ Commands:
 - `npx @salesforce-ux/slds-linter lint` - Runs the ESlint and Stylelint rules on your HTML/CSS/CMP files and outputs issues.
 - `npx @salesforce-ux/slds-linter lint:styles` - Runs the Stylelint rules on your CSS files and outputs issues.
 - `npx @salesforce-ux/slds-linter lint:components` - Runs the ESlint rules on your HTML/CMP files and outputs issues.
-- `npx @salesforce-ux/slds-linter fix`: Attempts to automatically fix violations.
+- `npx @salesforce-ux/slds-linter lint --fix`: Attempts to automatically fix violations.
 - `npx @salesforce-ux/slds-linter report`: Generates a SARIF report for static analysis.
 - `npx @salesforce-ux/slds-linter emit`: Emits the configuration files used by slds-linter cli (defaults to current directory). 
 
@@ -82,7 +82,7 @@ Commands:
 | `--config-eslint <path>` | Path to eslint config file'                    | lint                                       |
 | `--editor <editor>`      | Editor to open files with (e.g., vscode, atom, sublime). Defaults to vscode | lint,lint:styles, lint:components          |
 
-These options can also be visualised by using `--help` with each command. For example: Running `slds-linter lint --help` will give the options which can be used along with `lint`.
+These options can also be visualised by using `--help` with each command. For example: Running `npx @salesforce-ux/slds-linter lint --help` will give the options which can be used along with `lint`.
 
 #### Detailed Steps
 
@@ -91,7 +91,7 @@ These options can also be visualised by using `--help` with each command. For ex
 3. To run SLDS Linter, in Terminal, run `npx @salesforce-ux/slds-linter report` to generate a Sarif report in the project root directory. To run it on a different directory, use `-d` to run the report on that directory. For output, `-o` can be used to specify a different output folder for the genreated sarif. It will be named as `slds-linter-report.sarif`.
 4. Open the generated Sarif file.
 5. Make a note of how many components SLDS Linter has identified that you must update.
-6. Run `npx @salesforce-ux/slds-linter fix` to automatically fix validation errors in bulk.
+6. Run `npx @salesforce-ux/slds-linter lint --fix` to automatically fix validation errors in bulk.
 7. Run `npx @salesforce-ux/slds-linter emit` to emit the configuration files used by slds-linter cli, defaults to current working directory. These configuration files will be discovered by VSCode ESLint/Stylelint extensions to display squiggly lines in css/html files when opened in editor. Please ensure ESLint and Stylelint extensions are enabled.
 
 #### Troubleshooting SARIF Viewer Navigation

package/build/commands/emit.js

@@ -7,7 +7,7 @@ import {
   DEFAULT_STYLELINT_CONFIG_PATH
 } from "../services/config.resolver.js";
 import path from "path";
-import { execSync } from "child_process";
+import { copyFile } from "fs/promises";
 function registerEmitCommand(program) {
   program.command("emit").description("Emits the configuration files used by slds-linter cli").option(
     "-d, --directory <path>",
@@ -23,7 +23,7 @@ function registerEmitCommand(program) {
         normalizedOptions.directory,
         path.basename(normalizedOptions.configStyle)
       );
-      execSync(`cp ${normalizedOptions.configStyle} ${destStyleConfigPath}`);
+      await copyFile(normalizedOptions.configStyle, destStyleConfigPath);
       Logger.success(chalk.green(`Stylelint configuration created at:
 ${destStyleConfigPath}
 `));
@@ -31,9 +31,7 @@ ${destStyleConfigPath}
         normalizedOptions.directory,
         path.basename(normalizedOptions.configEslint)
       );
-      execSync(
-        `cp ${normalizedOptions.configEslint} ${destESLintConfigPath}`
-      );
+      await copyFile(normalizedOptions.configEslint, destESLintConfigPath);
       Logger.success(chalk.green(`ESLint configuration created at:
 ${destESLintConfigPath}
 `));

package/build/index.js

@@ -9,7 +9,7 @@ var require_package = __commonJS({
   "package.json"(exports, module) {
     module.exports = {
       name: "@salesforce-ux/slds-linter",
-      version: "0.0.13-alpha.1",
+      version: "0.1.0",
       description: "SLDS Linter CLI tool for linting styles and components",
       keywords: [
         "lightning design system linter",
@@ -36,8 +36,8 @@ var require_package = __commonJS({
         lint: "eslint src/**/*.ts"
       },
       dependencies: {
-        "@salesforce-ux/eslint-plugin-slds": "0.0.13-alpha.1",
-        "@salesforce-ux/stylelint-plugin-slds": "0.0.13-alpha.1",
+        "@salesforce-ux/eslint-plugin-slds": "0.1.0",
+        "@salesforce-ux/stylelint-plugin-slds": "0.1.0",
         "@typescript-eslint/eslint-plugin": "^5.0.0",
         "@typescript-eslint/parser": "^5.0.0",
         chalk: "^4.1.2",

package/build/services/report-generator.js

@@ -6,6 +6,7 @@ import { SarifBuilder, SarifRunBuilder, SarifResultBuilder, SarifRuleBuilder } f
 import { createWriteStream } from "fs";
 import { JsonStreamStringify } from "json-stream-stringify";
 import { getRuleDescription } from "./config.resolver.js";
+import { replaceNamespaceinRules } from "../utils/lintResultsUtil.js";
 var ReportGenerator = class {
   /**
    * Generate SARIF report from lint results
@@ -21,7 +22,7 @@ var ReportGenerator = class {
       const rules = this.extractRules(results);
       for (const rule of rules) {
         const ruleBuilder = new SarifRuleBuilder().initSimple({
-          ruleId: rule.id,
+          ruleId: replaceNamespaceinRules(rule.id),
           shortDescriptionText: rule.shortDescription?.text
         });
         runBuilder.addRule(ruleBuilder);
@@ -53,9 +54,9 @@ var ReportGenerator = class {
       for (const error of result.errors) {
         if (!rules.has(error.ruleId)) {
           rules.set(error.ruleId, {
-            id: error.ruleId,
+            id: replaceNamespaceinRules(error.ruleId),
             shortDescription: {
-              text: getRuleDescription(error.ruleId)
+              text: getRuleDescription(replaceNamespaceinRules(error.ruleId))
             },
             properties: {
               category: "Style"
@@ -66,9 +67,9 @@ var ReportGenerator = class {
       for (const warning of result.warnings) {
         if (!rules.has(warning.ruleId)) {
           rules.set(warning.ruleId, {
-            id: warning.ruleId,
+            id: replaceNamespaceinRules(warning.ruleId),
             shortDescription: {
-              text: getRuleDescription(warning.ruleId)
+              text: getRuleDescription(replaceNamespaceinRules(warning.ruleId))
             },
             properties: {
               category: "Style"
@@ -85,7 +86,7 @@ var ReportGenerator = class {
   static addResultsToSarif(runBuilder, lintResult) {
     for (const error of lintResult.errors) {
       const resultBuilder = new SarifResultBuilder().initSimple({
-        ruleId: error.ruleId,
+        ruleId: replaceNamespaceinRules(error.ruleId),
         level: "error",
         messageText: error.message,
         fileUri: lintResult.filePath,
@@ -98,7 +99,7 @@ var ReportGenerator = class {
     }
     for (const warning of lintResult.warnings) {
       const resultBuilder = new SarifResultBuilder().initSimple({
-        ruleId: warning.ruleId,
+        ruleId: replaceNamespaceinRules(warning.ruleId),
         level: "warning",
         messageText: warning.message,
         fileUri: lintResult.filePath,

package/build/utils/lintResultsUtil.d.ts

@@ -1,4 +1,10 @@
 import { LintResult } from '../types';
+/**
+ *
+ * @param id - Rule id
+ * @returns updated Rule id without the namespace @salesforce-ux
+ */
+export declare function replaceNamespaceinRules(id: string): string;
 /**
  * Prints detailed lint results for each file that has issues.
  *

package/build/utils/lintResultsUtil.js

@@ -3,6 +3,9 @@ import chalk from "chalk";
 import path from "path";
 import { createClickableLineCol } from "./editorLinkUtil.js";
 import { Logger } from "../utils/logger.js";
+function replaceNamespaceinRules(id) {
+  return id.includes("@salesforce-ux/") ? id.replace("@salesforce-ux/", "") : id;
+}
 function printLintResults(results, editor) {
   results.forEach((result) => {
     const hasErrors = result.errors && result.errors.length > 0;
@@ -17,7 +20,7 @@ ${chalk.bold(relativeFile)}`);
         if (error.line && error.column && absolutePath) {
           const lineCol = `${error.line}:${error.column}`;
           const clickable = createClickableLineCol(lineCol, absolutePath, error.line, error.column, editor);
-          const ruleId = error.ruleId ? chalk.dim(error.ruleId) : "";
+          const ruleId = error.ruleId ? chalk.dim(replaceNamespaceinRules(error.ruleId)) : "";
           Logger.error(`  ${clickable}  ${error.message}  ${ruleId}`);
         } else {
           Logger.error(`  ${chalk.red("Error:")} ${error.message}`);
@@ -29,7 +32,7 @@ ${chalk.bold(relativeFile)}`);
         if (warn.line && warn.column && absolutePath) {
           const lineCol = `${warn.line}:${warn.column}`;
           const clickable = createClickableLineCol(lineCol, absolutePath, warn.line, warn.column, editor);
-          const ruleId = warn.ruleId ? chalk.dim(warn.ruleId) : "";
+          const ruleId = warn.ruleId ? chalk.dim(replaceNamespaceinRules(warn.ruleId)) : "";
           Logger.warning(`  ${clickable}  ${warn.message}  ${ruleId}`);
         } else {
           Logger.warning(`  ${chalk.yellow("Warning:")} ${warn.message}`);
@@ -39,5 +42,6 @@ ${chalk.bold(relativeFile)}`);
   });
 }
 export {
-  printLintResults
+  printLintResults,
+  replaceNamespaceinRules
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce-ux/slds-linter",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "SLDS Linter CLI tool for linting styles and components",
   "keywords": [
     "lightning design system linter",
@@ -20,8 +20,8 @@
     "slds-linter": "./build/index.js"
   },
   "dependencies": {
-    "@salesforce-ux/eslint-plugin-slds": "0.1.0",
-    "@salesforce-ux/stylelint-plugin-slds": "0.1.0",
+    "@salesforce-ux/eslint-plugin-slds": "0.1.1",
+    "@salesforce-ux/stylelint-plugin-slds": "0.1.1",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "chalk": "^4.1.2",