feat!: correct warnings, expand test coverage

castastrophe · castastrophe · commit b14efc76b162 · 2025-02-15T11:23:50.000-05:00
Breaking change: update yarn to latest version
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,5 @@
+README.md merge=ours
+
+# Treat yarn assets as binaries for diffing
+/.yarn/releases/** binary
+/.yarn/plugins/** binary
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,25 @@
-/node_modules
+**/node_modules/**
+
+# Logs
 npm-debug.log
+yarn-error.log
+npm-debug.log*
+
+# System files
 .DS_Store
+
+# Test files
 coverage/
+
+# IDE files
 .env
+.tmp
+
+# yarn
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no-install commitlint --edit ""
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1 @@
+yarn test
diff --git a/.yarn/releases/yarn-4.6.0.cjs b/.yarn/releases/yarn-4.6.0.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,5 @@
+cacheFolder: ./.yarn/cache
+
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.6.0.cjs
diff --git a/expected/custom_copyright.css b/expected/custom_copyright.css
@@ -0,0 +1,10 @@
+/*!
+ * Copyright 2025. All rights reserved.
+ *
+ * This file is licensed.
+ */
+
+.class-name {
+  --background-color: purple;
+  --border-color: transparent;
+}
diff --git a/expected/empty.css b/expected/empty.css
diff --git a/expected/empty_with_license.css b/expected/empty_with_license.css
@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2023. All rights reserved.
+ *
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at <http://www.apache.org/licenses/LICENSE-2.0>
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
diff --git a/fixtures/CUSTOM_COPYRIGHT b/fixtures/CUSTOM_COPYRIGHT
@@ -0,0 +1,3 @@
+Copyright 2025. All rights reserved.
+
+This file is licensed.
diff --git a/fixtures/empty.css b/fixtures/empty.css
diff --git a/index.js b/index.js
@@ -3,11 +3,16 @@ const { join } = require("path");
 
 /**
  * @typedef {object} Options
- * @property {string[]=} filename
- * @property {string=} cwd
- * @property {boolean=} skipIfEmpty
+ * @property {string[]} filename
+ * @property {string} cwd
+ * @property {boolean} skipIfEmpty
  */
 
+const messages = {
+    fileNotFound: (path) =>
+        `File(s) not found at ${path}. Please specify a path with the filename option or create a COPYRIGHT file in the root of the project.`,
+};
+
 /**
  * @type {import('postcss').PluginCreator<Options>}
  * @param {Options} options
@@ -21,44 +26,40 @@ module.exports = (options = { filename, cwd, skipIfEmpty }) => {
     } = options;
     return {
         postcssPlugin: "postcss-licensing",
-        OnceExit(css, { Comment }) {
-            // Don't add a license if there are no nodes
+        OnceExit(css, { Comment, result }) {
+            /* Don't add a license if there are no nodes unless opted in via skipIfEmpty = false */
             if (css.nodes.length === 0 && skipIfEmpty) {
                 css.cleanRaws();
                 return;
             }
 
-            function checkForFile(cwd, file) {
-                const path = join(cwd, file);
-                if (!existsSync(path)) return;
-                return path;
-            }
-
             /* Fetch the license from the provided location */
-            let path;
-
             if (typeof filename === "string") {
                 filename = [filename];
             }
 
+            /* Find which file can be found in the order provided */
+            let content;
             filename.forEach((f) => {
-                if (path) return;
-                else path = checkForFile(cwd, f);
-            });
+                // If we already found a file, don't look for another
+                if (content) return;
+                else if (existsSync(join(cwd, f))) {
+                    content = readFileSync(join(cwd, f), "utf8")?.trim();
 
-            if (!existsSync(path)) {
-                return css.error(
-                `File not found at ${path}. Please specify a path with the filename option or create a COPYRIGHT file in the root of the project.`
-                );
-            }
+                    // If the file is empty, reset content to undefined
+                    if (!content) content = undefined;
+                }
+            });
 
-            const content = readFileSync(path, "utf8").trim();
+            /* If none of the provided paths exist, return a warning */
             if (!content) {
-                css.error(
-                `File is empty at ${path}. Please specify a path with the filename option or create a COPYRIGHT file in the root of the project.`
+                return result.warn(
+                    messages.fileNotFound(filename.join(", ")),
+                    { node: css }
                 );
             }
 
+            // Add the license to the top of the file
             const lines = content.split("\n").map((l) => l.trim());
             const text = lines.map((l) => (l ? ` * ${l}` : " *")).join("\n");
             const comment = new Comment({
@@ -67,11 +68,15 @@ module.exports = (options = { filename, cwd, skipIfEmpty }) => {
             });
 
             css.prepend(comment);
+
             if (comment.next()) {
                 comment.next().raws.before = "\n\n";
+            } else {
+                comment.parent.raws.after = "\n";
             }
         },
     };
 };
 
 module.postcss = true;
+module.exports.messages = messages;
diff --git a/package.json b/package.json
@@ -1,5 +1,4 @@
 {
-  "private": false,
   "name": "postcss-licensing",
   "version": "2.0.0",
   "description": "Prepends licensing information to CSS files",
@@ -20,12 +19,13 @@
     "node": ">=20"
   },
   "scripts": {
-    "postinstall": "husky || true",
+    "coverage": "c8 yarn test",
     "prepack": "pinst --disable",
+    "prepare": "husky",
+    "postinstall": "husky || true",
     "postpack": "pinst --enable",
-    "test": "ava",
-    "coverage": "c8 yarn test",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "test": "ava"
   },
   "funding": [
     {
@@ -72,5 +72,6 @@
     "package.json": [
       "prettier-package-json --write"
     ]
-  }
+  },
+  "packageManager": "yarn@4.6.0"
 }
diff --git a/test.js b/test.js
@@ -1,7 +1,9 @@
 const fs = require("fs");
 const test = require("ava");
 const postcss = require("postcss");
+
 const plugin = require("./index.js");
+const { messages } = require("./index.js");
 
 function compare(
   t,
@@ -24,6 +26,37 @@ function compare(
     });
 }
 
+function fetchWarnings(
+  fixtureFilePath,
+  options = {}
+) {
+  return postcss([plugin(options)])
+    .process(fs.readFileSync(`./fixtures/${fixtureFilePath}`, "utf8"), {
+      from: fixtureFilePath,
+    })
+    .then((result) => {
+      return result.warnings();
+    });
+}
+
 test("create basic output", (t) => {
   return compare(t, "basic.css", "basic.css");
 });
+
+test("add no license if the file is empty", (t) => {
+  return compare(t, "empty.css", "empty.css");
+});
+
+test("load license from file", (t) => {
+  return compare(t, "basic.css", "custom_copyright.css", { filename: './fixtures/CUSTOM_COPYRIGHT' });
+});
+
+test("add license to empty file is option skipIfEmpty = false", (t) => {
+  return compare(t, "empty.css", "empty_with_license.css", { skipIfEmpty: false });
+});
+
+test("warn if files don't exist", async (t) => {
+  const warnings = await fetchWarnings("basic.css", { filename: './fixtures/FAIL_COPYRIGHT' });
+  t.is(warnings.length, 1);
+  t.is(warnings?.[0]?.text, messages.fileNotFound('./fixtures/FAIL_COPYRIGHT'));
+});
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Copyright 2025. All rights reserved.`
	`2`	`+`
	`3`	`+This file is licensed.`