stylelint-copyright 0.0.0-4754

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+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,22 @@
+# `stylelint-copyright`
+
+Stylelint plugin to check CSS files for a copyright header.
+
+```css
+/*
+ * Copyright ...
+ * ...
+ */
+```
+
+## Usage
+
+```json
+// .stylelintrc
+{
+  "plugins": ["stylelint-copyright"],
+  "rules": {
+    "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

@@ -0,0 +1,57 @@
+/**
+ * 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 stylelint = require('stylelint');
+
+const ruleName = 'docusaurus/copyright-header';
+const messages = stylelint.utils.ruleMessages(ruleName, {
+  rejected: 'Missing copyright in the header comment',
+});
+
+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: root,
+      result,
+      ruleName,
+    });
+  },
+);
+
+module.exports = plugin;
+module.exports.ruleName = ruleName;
+module.exports.messages = messages;

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "stylelint-copyright",
+  "version": "0.0.0-4754",
+  "description": "Stylelint plugin to check CSS files for a copyright header.",
+  "main": "index.js",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/stylelint-copyright"
+  },
+  "dependencies": {
+    "stylelint": "^14.6.0"
+  },
+  "gitHead": "6c1c0d9bb0878c738732b8678af70a8dc04ee0a4"
+}