stylelint-copyright 2.0.0-alpha.69 → 2.0.0-beta.18

package/README.md

@@ -1,6 +1,6 @@
-# stylelint-copyright
+# `stylelint-copyright`
 
-stylelint plugin to check CSS files for a copyright header.
+Stylelint plugin to check CSS files for a copyright header.
 
 ```css
 /*
@@ -16,7 +16,7 @@ stylelint plugin to check CSS files for a copyright header.
 {
   "plugins": ["stylelint-copyright"],
   "rules": {
-    "docusaurus/copyright-header": true
+    "docusaurus/copyright-header": [true, {"header": "\n * Copyright"}]
   }
 }
 ```

package/__tests__/index.test.js

@@ -0,0 +1,226 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/* eslint-disable jest/no-conditional-expect */
+
+const stylelint = require('stylelint');
+const path = require('path');
+const rule = require('..');
+
+const {ruleName, messages} = rule;
+
+function getOutputCss(output) {
+  // eslint-disable-next-line no-underscore-dangle
+  const result = output.results[0]._postcssResult;
+  return result.root.toString(result.opts.syntax);
+}
+
+function testStylelintRule(config, tests) {
+  describe(`${tests.ruleName}`, () => {
+    const checkTestCaseContent = (testCase) =>
+      testCase.description || testCase.code || 'no description';
+
+    if (tests.accept?.length) {
+      describe('accept cases', () => {
+        tests.accept.forEach((testCase) => {
+          it(`${checkTestCaseContent(testCase)}`, async () => {
+            const options = {
+              code: testCase.code,
+              config,
+              syntax: tests.syntax,
+            };
+
+            const output = await stylelint.lint(options);
+            expect(output.results[0].warnings).toEqual([]);
+            if (!tests.fix) {
+              return;
+            }
+            const fixedOutput = await stylelint.lint({...options, fix: true});
+            const fixedCode = getOutputCss(fixedOutput);
+            expect(fixedCode).toBe(testCase.code);
+          });
+        });
+      });
+    }
+
+    if (tests.reject?.length) {
+      describe('reject cases', () => {
+        tests.reject.forEach((testCase) => {
+          it(`${checkTestCaseContent(testCase)}`, async () => {
+            const options = {
+              code: testCase.code,
+              config,
+              syntax: tests.syntax,
+            };
+
+            const output = await stylelint.lint(options);
+            const {warnings} = output.results[0];
+            const warning = warnings[0];
+            expect(warnings.length).toBeGreaterThanOrEqual(1);
+            expect(testCase).toHaveMessage();
+            if (testCase.message != null) {
+              expect(warning.text).toBe(testCase.message);
+            }
+            if (testCase.line != null) {
+              expect(warning.line).toBe(testCase.line);
+            }
+            if (testCase.column != null) {
+              expect(warning.column).toBe(testCase.column);
+            }
+            if (!tests.fix) {
+              return;
+            }
+            if (!testCase.fixed) {
+              throw new Error(
+                'If using { fix: true } in test tests, all reject cases must have { fixed: .. }',
+              );
+            }
+            const fixedOutput = await stylelint.lint({...options, fix: true});
+            const fixedCode = getOutputCss(fixedOutput);
+            expect(fixedCode).toBe(testCase.fixed);
+          });
+        });
+      });
+    }
+
+    expect.extend({
+      toHaveMessage(testCase) {
+        if (testCase.message == null) {
+          return {
+            message: () =>
+              'Expected "reject" test case to have a "message" property',
+            pass: false,
+          };
+        }
+
+        return {
+          pass: true,
+        };
+      },
+    });
+  });
+}
+
+testStylelintRule(
+  {
+    plugins: [path.join(__dirname, '..')],
+    rules: {
+      [ruleName]: [true, {header: '*\n * Copyright'}],
+    },
+  },
+  {
+    ruleName,
+    fix: true,
+    accept: [
+      {
+        code: `
+/**
+ * Copyright
+ */
+.foo {}`,
+      },
+      {
+        code: `/**
+ * Copyright
+ */
+
+.foo {}`,
+      },
+      {
+        code: `/**
+ * Copyright
+ */
+.foo {}`,
+      },
+    ],
+    reject: [
+      {
+        code: `.foo {}`,
+        fixed: `/**
+ * Copyright
+ */
+.foo {}`,
+        message: messages.rejected,
+        line: 1,
+        column: 1,
+      },
+      {
+        code: `
+.foo {}`,
+        fixed: `/**
+ * Copyright
+ */
+.foo {}`,
+        message: messages.rejected,
+        line: 1,
+        column: 1,
+      },
+      {
+        code: `/**
+* Copyright
+*/
+
+.foo {}`,
+        fixed: `/**
+ * Copyright
+ */
+
+/**
+* Copyright
+*/
+
+.foo {}`,
+        message: messages.rejected,
+        line: 1,
+        column: 1,
+      },
+      {
+        code: `/**
+ * Copyleft
+ */
+
+.foo {}`,
+        fixed: `/**
+ * Copyright
+ */
+
+/**
+ * Copyleft
+ */
+
+.foo {}`,
+        message: messages.rejected,
+        line: 1,
+        column: 1,
+      },
+      {
+        code: `/**
+ * Copyleft
+ */
+
+/**
+ * Copyright
+ */
+ .foo {}`,
+        fixed: `/**
+ * Copyright
+ */
+
+/**
+ * Copyleft
+ */
+
+/**
+ * Copyright
+ */
+ .foo {}`,
+        message: messages.rejected,
+        line: 1,
+        column: 1,
+      },
+    ],
+  },
+);

package/index.js

@@ -12,44 +12,46 @@ const messages = stylelint.utils.ruleMessages(ruleName, {
   rejected: 'Missing copyright in the header comment',
 });
 
-module.exports = stylelint.createPlugin(ruleName, (actual) => {
-  return (root, result) => {
-    const validOptions = stylelint.utils.validateOptions(result, ruleName, {
-      actual,
-    });
-
-    if (!validOptions) {
-      return;
-    }
-
-    root.walkComments((comment) => {
-      // Ignore root comments with copyright text.
-      if (
-        comment === comment.parent.first &&
-        /[Cc]opyright/.test(comment.text)
-      ) {
-        return;
-      }
-
-      // Ignore non-root comments.
-      if (comment.type !== 'root' && comment !== comment.parent.first) {
-        return;
-      }
-
-      // Ignore indented comments.
-      if (comment.source.start.column > 1) {
+const plugin = stylelint.createPlugin(
+  ruleName,
+  (primaryOption, secondaryOption, context) => (root, result) => {
+    stylelint.utils.validateOptions(
+      result,
+      ruleName,
+      {
+        actual: primaryOption,
+        possible: [true, false],
+      },
+      {
+        actual: secondaryOption,
+        possible: (v) => typeof v.header === 'string',
+      },
+    );
+
+    if (
+      root.first &&
+      root.first.type === 'comment' &&
+      root.first.source.start.column === 1
+    ) {
+      const {text} = root.first;
+      if (text === secondaryOption.header) {
         return;
       }
+    }
+    if (context.fix) {
+      root.first?.before(`/*${secondaryOption.header}\n */`);
+      return;
+    }
 
-      stylelint.utils.report({
-        message: messages.rejected,
-        node: comment,
-        result,
-        ruleName,
-      });
+    stylelint.utils.report({
+      message: messages.rejected,
+      node: root,
+      result,
+      ruleName,
     });
-  };
-});
+  },
+);
 
+module.exports = plugin;
 module.exports.ruleName = ruleName;
 module.exports.messages = messages;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stylelint-copyright",
-  "version": "2.0.0-alpha.69",
-  "description": "stylelint plugin to check css files for a copyright header",
+  "version": "2.0.0-beta.18",
+  "description": "Stylelint plugin to check CSS files for a copyright header.",
   "main": "index.js",
   "license": "MIT",
   "repository": {
@@ -10,7 +10,7 @@
     "directory": "packages/stylelint-copyright"
   },
   "dependencies": {
-    "stylelint": "^13.2.1"
+    "stylelint": "^14.6.0"
   },
-  "gitHead": "4410a9eb01b87c2df664986ba37e748ed34a3c78"
+  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
 }

package/__tests__/index.js

@@ -1,69 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const rule = require('..');
-
-const {ruleName, messages} = rule;
-
-testStylelintRule(
-  {
-    // Relative to repo root.
-    plugins: ['./packages/stylelint-copyright'],
-    rules: {
-      [ruleName]: true,
-    },
-  },
-  {
-    ruleName,
-    fix: false,
-    accept: [
-      {
-        code: `
-/**
- * Copyright
- */
-
- .foo {}`,
-      },
-      {
-        code: `
-      /**
- * copyright
- */
-
- .foo {}`,
-      },
-    ],
-    reject: [
-      {
-        code: `
-/**
- * Copyleft
- */
-
- .foo {}`,
-        message: messages.rejected,
-        line: 2,
-        column: 1,
-      },
-      {
-        code: `
-/**
- * Copyleft
- */
-
-/**
- * Copyright
- */
- .foo {}`,
-        message: messages.rejected,
-        line: 2,
-        column: 1,
-      },
-    ],
-  },
-);