@dialpad/stylelint-plugin-dialtone 1.0.1

package/.eslintrc.js

@@ -0,0 +1,17 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    parser: "vue-eslint-parser"
+  },
+  env: {
+    node: true,
+  },
+};

package/.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.markdownlint.json"
+}

package/CHANGELOG.json

@@ -0,0 +1 @@
+{"versions":[{"version":"1.0.1","title":"[1.0.1](https://github.com/dialpad/dialtone/compare/stylelint-plugin-dialtone/v1.0.0...stylelint-plugin-dialtone/v1.0.1) (2024-03-20)","date":"2024-03-20","body":"### Bug Fixes\n\n* use mixin property to detect mixin ([#215](https://github.com/dialpad/dialtone/issues/215)) ([493f58e](https://github.com/dialpad/dialtone/commit/493f58ef37ea14392bfee0fabc7c0cf8fa524d2a))\n\n\n\n### Features\n\n* dialtone stylelint plugin - no mixins rule ([#186](https://github.com/dialpad/dialtone/issues/186)) ([8fe0ffb](https://github.com/dialpad/dialtone/commit/8fe0ffb7f4dd81cbf19e6cbbe37b16ca609973cd))","parsed":{"_":["use mixin property to detect mixin (#215) (493f58e)","dialtone stylelint plugin - no mixins rule (#186) (8fe0ffb)"],"Bug Fixes":["use mixin property to detect mixin (#215) (493f58e)"],"Features":["dialtone stylelint plugin - no mixins rule (#186) (8fe0ffb)"]}}],"title":"1.0.0 (2024-03-07)"}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [1.0.1](https://github.com/dialpad/dialtone/compare/stylelint-plugin-dialtone/v1.0.0...stylelint-plugin-dialtone/v1.0.1) (2024-03-20)
+
+
+### Bug Fixes
+
+* use mixin property to detect mixin ([#215](https://github.com/dialpad/dialtone/issues/215)) ([493f58e](https://github.com/dialpad/dialtone/commit/493f58ef37ea14392bfee0fabc7c0cf8fa524d2a))
+
+# 1.0.0 (2024-03-07)
+
+
+### Features
+
+* dialtone stylelint plugin - no mixins rule ([#186](https://github.com/dialpad/dialtone/issues/186)) ([8fe0ffb](https://github.com/dialpad/dialtone/commit/8fe0ffb7f4dd81cbf19e6cbbe37b16ca609973cd))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dialpad
+
+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,37 @@
+# stylelint-plugin-dialtone
+
+Dialtone StyleLint plugin containing rules to help developers maintain dialtone recommended practices for CSS.
+
+## Installation
+
+You'll first need to install [stylelint](https://stylelint.io/) into your project:
+
+```sh
+npm install -D stylelint
+```
+
+Next, install `@dialpad/stylelint-plugin-dialtone`:
+
+```sh
+npm install -D @dialpad/stylelint-plugin-dialtone
+```
+
+## Usage
+
+Add `@dialpad/stylelint-plugin-dialtone` to the plugins array in your stylelint.config file.
+
+```json
+{
+  "plugins": ["@dialpad/stylelint-plugin-dialtone"],
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "@dialpad/stylelint-plugin-dialtone/no-mixins": true
+  }
+}
+```

package/docs/rules/no-mixins.md

@@ -0,0 +1,35 @@
+# Detects usage of LESS mixins (no-mixins)
+
+LESS mixin usage is one of the primary causes of our extremely slow front end build performance. We are attempting to remove as many LESS mixins as possible and eventually transition to a more modern pure CSS approach.
+
+## Rule Details
+
+This rule aims to detect and prevent usage of LESS mixins.
+
+Examples of **incorrect** code for this rule:
+
+Mixin usage:
+
+```css
+.a {
+  .aMixin();
+}
+```
+
+Older style mixin syntax usage:
+
+```css
+.a {
+ .aMixin;
+}
+```
+
+Examples of **correct** code for this rule:
+
+No mixins used.
+
+```css
+.a {
+  color: var(--dt-color-foreground-critical);
+}
+```

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+const noMixins = require("./rules/no-mixins");
+
+module.exports = [noMixins];

package/lib/rules/no-mixins.js

@@ -0,0 +1,47 @@
+const stylelint = require("stylelint");
+
+const {
+  createPlugin,
+  utils: { report, ruleMessages, validateOptions },
+} = stylelint;
+
+const ruleName = '@dialpad/stylelint-plugin-dialtone/no-mixins';
+
+const messages = ruleMessages(ruleName, {
+  noMixinsRejected: (mixinName) => `Please avoid using LESS mixins "${mixinName}"`,
+});
+
+const meta = {
+  url: "https://github.com/dialpad/dialtone/blob/staging/packages/stylelint-plugin-dialtone/docs/rules/no-mixins.md",
+};
+
+/** @type {import('stylelint').Rule} */
+const ruleFunction = (primary) => {
+  return (root, result) => {
+    const validOptions = validateOptions(result, ruleName, {
+      actual: primary,
+    });
+
+    if (!validOptions) return;
+
+    // This iterates through one selector at a time, so you don't have to worry about checking for nested selectors.
+    root.walkAtRules((ruleNode) => {
+      // docs for mixin property used here: https://github.com/shellscape/postcss-less?tab=readme-ov-file#mixins
+      if (!ruleNode.mixin) return;
+      report({
+        result,
+        ruleName,
+        node: ruleNode,
+        start: ruleNode.source.start,
+        end: ruleNode.source.end,
+        message: messages.noMixinsRejected(ruleNode.name),
+      });
+    });
+  };
+};
+
+ruleFunction.ruleName = ruleName;
+ruleFunction.messages = messages;
+ruleFunction.meta = meta;
+
+module.exports = createPlugin(ruleName, ruleFunction);

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@dialpad/stylelint-plugin-dialtone",
+  "version": "1.0.1",
+  "description": "dialtone stylelint plugin",
+  "keywords": [
+    "Dialpad",
+    "Dialtone",
+    "stylelint"
+  ],
+  "contributors": [
+    {
+      "name": "Brad Paugh",
+      "email": "brad.paugh@dialpad.com",
+      "url": "https://github.com/braddialpad"
+    },
+    {
+      "name": "Francis Rupert",
+      "email": "francis.rupert@dialpad.com",
+      "url": "https://github.com/francisrupert"
+    },
+    {
+      "name": "Julio Ortega",
+      "email": "julio.ortega@dialpad.com",
+      "url": "https://github.com/juliodialpad"
+    },
+    {
+      "name": "Ignacio Ropolo",
+      "email": "ignacio.ropolo@dialpad.com",
+      "url": "https://github.com/iropolo"
+    },
+    {
+      "name": "Nina Repetto",
+      "email": "nina.repetto@dialpad.com",
+      "url": "https://github.com/ninamarina"
+    }
+  ],
+  "bugs": {
+    "email": "dialtone@dialpad.com"
+  },
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "devDependencies": {
+    "stylelint": "15.11.0",
+    "stylelint-test-rule-node": "^0.2.1"
+  },
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "peerDependencies": {
+    "stylelint": "^14.0.0 || ^15.0.0"
+  },
+  "scripts": {
+    "lint": "run-s lint:docs lint:code",
+    "lint:code": "eslint '**/*.js'",
+    "lint:docs": "markdownlint 'docs/**/*.md'",
+    "test": "node --test ./tests/lib/rules/*.mjs"
+  }
+}

package/project.json

@@ -0,0 +1,26 @@
+{
+  "name": "stylelint-plugin-dialtone",
+  "targets": {
+    "publish": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "pnpm publish --filter ./packages/stylelint-plugin-dialtone",
+        "parallel": false
+      }
+    },
+    "release-github": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "pnpm semantic-release-plus --extends ./packages/stylelint-plugin-dialtone/release-ci.config.cjs",
+        "parallel": false
+      }
+    },
+    "release-local": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "pnpm semantic-release-plus --no-ci --extends ./packages/stylelint-plugin-dialtone/release-local.config.cjs",
+        "parallel": false
+      }
+    }
+  }
+}

package/release-ci.config.cjs

@@ -0,0 +1,32 @@
+const name = 'stylelint-plugin-dialtone';
+const srcRoot = `packages/${name}`;
+
+module.exports = {
+  extends: 'release.config.base.js',
+  pkgRoot: srcRoot,
+  tagFormat: name + '/v${version}',
+  commitPaths: [`${srcRoot}/*`],
+  plugins: [
+    ['@semantic-release/commit-analyzer', {
+      preset: 'angular',
+      releaseRules: [
+        { type: 'refactor', release: 'patch' },
+      ],
+    }],
+    ['@semantic-release/release-notes-generator', {
+      config: '@dialpad/conventional-changelog-angular',
+    }],
+    '@semantic-release/github',
+  ],
+  branches: [
+    'production',
+    {
+      name: 'beta',
+      prerelease: true,
+    },
+    {
+      name: 'alpha',
+      prerelease: true,
+    },
+  ],
+};

package/release-local.config.cjs

@@ -0,0 +1,40 @@
+const name = 'stylelint-plugin-dialtone';
+const srcRoot = `packages/${name}`;
+
+module.exports = {
+  extends: 'release.config.base.js',
+  pkgRoot: srcRoot,
+  tagFormat: name + '/v${version}',
+  commitPaths: [`${srcRoot}/*`],
+  assets: [`${srcRoot}/CHANGELOG.md`, `${srcRoot}/CHANGELOG.json`, `${srcRoot}/package.json`],
+  plugins: [
+    ['@semantic-release/commit-analyzer', {
+      preset: 'angular',
+      releaseRules: [
+        { type: 'refactor', release: 'patch' },
+      ],
+    }],
+    ['@semantic-release/release-notes-generator', {
+      config: '@dialpad/conventional-changelog-angular',
+    }],
+    ['@dialpad/semantic-release-changelog-json', { changelogFile: `${srcRoot}/CHANGELOG.md`, changelogJsonFile: `${srcRoot}/CHANGELOG.json` }],
+    ['@semantic-release/changelog', { changelogFile: `${srcRoot}/CHANGELOG.md` }],
+    ['@semantic-release/npm', { npmPublish: false }],
+    ['@semantic-release/git', {
+      /* eslint-disable-next-line no-template-curly-in-string */
+      message: `chore(release): ${name}` +
+        '/v${nextRelease.version}\n\n${nextRelease.notes}',
+    }],
+  ],
+  branches: [
+    'staging',
+    {
+      name: 'beta',
+      prerelease: true,
+    },
+    {
+      name: 'alpha',
+      prerelease: true,
+    },
+  ],
+};

package/tests/lib/rules/no-mixins.mjs

@@ -0,0 +1,51 @@
+import { testRule } from 'stylelint-test-rule-node';
+
+import plugin from '../../../lib/rules/no-mixins.js';
+
+const {
+  rule: { messages, ruleName },
+} = plugin;
+
+testRule({
+  plugins: [plugin],
+  ruleName,
+  config: true,
+  customSyntax: 'postcss-less',
+
+  accept: [
+    {
+      code: '.a { color: red; }',
+      description: 'simple class definition with no LESS mixin',
+    },
+  ],
+
+  reject: [
+    {
+      code: `.a {
+        .aMixin();
+      }`,
+      description: 'simple class definition containing a LESS mixin',
+      message: messages.noMixinsRejected('aMixin'),
+    },
+    {
+      code: `.a {
+        .aMixin;
+      }`,
+      description: 'simple class definition containing the older syntax for LESS mixins',
+      message: messages.noMixinsRejected('aMixin'),
+    },
+    {
+      code: `.a {
+        color: red;
+        .aMixin;
+        vertical-align: middle;
+        .otherMixin();
+      }`,
+      description: 'multiple mixins in a class definition',
+      warnings: [
+        { message: messages.noMixinsRejected('aMixin') },
+        { message: messages.noMixinsRejected('otherMixin') },
+      ],
+    },
+  ],
+});