postcss-base-plugin

Author: romainmenke

plugins/postcss-base-plugin/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+package-lock.json
+yarn.lock
+*.result.css
+*.result.css.map
+dist/*

plugins/postcss-base-plugin/.tape.js

@@ -0,0 +1,14 @@
+module.exports = {
+	basic: {
+		message: "supports basic usage",
+	},
+	'basic:color': {
+		message: "supports { color: '<a color>' }",
+		options: {
+			color: 'purple'
+		}
+	},
+	example: {
+		message: "minimal example",
+	},
+};

plugins/postcss-base-plugin/CHANGELOG.md

@@ -0,0 +1 @@
+# Changes to PostCSS Base Plugin

plugins/postcss-base-plugin/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to PostCSS Base Plugin
+
+You want to help? You rock! Now, take a moment to be sure your contributions
+make sense to everyone else.
+
+## Reporting Issues
+
+Found a problem? Want a new feature?
+
+- See if your issue or idea has [already been reported].
+- Provide a [reduced test case] or a [live example].
+
+Remember, a bug is a _demonstrable problem_ caused by _our_ code.
+
+## Submitting Pull Requests
+
+Pull requests are the greatest contributions, so be sure they are focused in
+scope and avoid unrelated commits.
+
+1. To begin; [fork this project], clone your fork, and add our upstream.
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone git@github.com:YOUR_USER/postcss-dir-pseudo-class.git
+
+   # Navigate to the newly cloned directory
+   cd postcss-dir-pseudo-class
+
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream git@github.com:jonathantneal/postcss-dir-pseudo-class.git
+
+   # Install the tools necessary for testing
+   npm install
+   ```
+
+2. Create a branch for your feature or fix:
+   ```bash
+   # Move into a new branch for your feature
+   git checkout -b feature/thing
+   ```
+   ```bash
+   # Move into a new branch for your fix
+   git checkout -b fix/something
+   ```
+
+3. If your code follows our practices, then push your feature branch:
+   ```bash
+   # Test current code
+   npm test
+   ```
+   ```bash
+   # Push the branch for your new feature
+   git push origin feature/thing
+   ```
+   ```bash
+   # Or, push the branch for your update
+   git push origin update/something
+   ```
+
+That’s it! Now [open a pull request] with a clear title and description.
+
+[already been reported]: issues
+[fork this project]:     fork
+[live example]:          https://codepen.io/pen
+[open a pull request]:   https://help.github.com/articles/using-pull-requests/
+[reduced test case]:     https://css-tricks.com/reduced-test-cases/

plugins/postcss-base-plugin/INSTALL.md

@@ -0,0 +1,3 @@
+# Installing PostCSS Base Plugin
+
+<!-- TODO -->

plugins/postcss-base-plugin/LICENSE.md

@@ -0,0 +1,108 @@
+# CC0 1.0 Universal
+
+## Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an “owner”) of an original work of
+authorship and/or a database (each, a “Work”).
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific works
+(“Commons”) that the public can reliably and without fear of later claims of
+infringement build upon, modify, incorporate in other works, reuse and
+redistribute as freely as possible in any form whatsoever and for any purposes,
+including without limitation commercial purposes. These owners may contribute
+to the Commons to promote the ideal of a free culture and the further
+production of creative, cultural and scientific works, or to gain reputation or
+greater distribution for their Work in part through the use and efforts of
+others.
+
+For these and/or other purposes and motivations, and without any expectation of
+additional consideration or compensation, the person associating CC0 with a
+Work (the “Affirmer”), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
+publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+   protected by copyright and related or neighboring rights (“Copyright and
+   Related Rights”). Copyright and Related Rights include, but are not limited
+   to, the following:
+   1. the right to reproduce, adapt, distribute, perform, display, communicate,
+      and translate a Work;
+   2. moral rights retained by the original author(s) and/or performer(s);
+   3. publicity and privacy rights pertaining to a person’s image or likeness
+      depicted in a Work;
+   4. rights protecting against unfair competition in regards to a Work,
+      subject to the limitations in paragraph 4(i), below;
+   5. rights protecting the extraction, dissemination, use and reuse of data in
+      a Work;
+   6. database rights (such as those arising under Directive 96/9/EC of the
+      European Parliament and of the Council of 11 March 1996 on the legal
+      protection of databases, and under any national implementation thereof,
+      including any amended or successor version of such directive); and
+   7. other similar, equivalent or corresponding rights throughout the world
+      based on applicable law or treaty, and any national implementations
+      thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+   applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+   unconditionally waives, abandons, and surrenders all of Affirmer’s Copyright
+   and Related Rights and associated claims and causes of action, whether now
+   known or unknown (including existing as well as future claims and causes of
+   action), in the Work (i) in all territories worldwide, (ii) for the maximum
+   duration provided by applicable law or treaty (including future time
+   extensions), (iii) in any current or future medium and for any number of
+   copies, and (iv) for any purpose whatsoever, including without limitation
+   commercial, advertising or promotional purposes (the “Waiver”). Affirmer
+   makes the Waiver for the benefit of each member of the public at large and
+   to the detriment of Affirmer’s heirs and successors, fully intending that
+   such Waiver shall not be subject to revocation, rescission, cancellation,
+   termination, or any other legal or equitable action to disrupt the quiet
+   enjoyment of the Work by the public as contemplated by Affirmer’s express
+   Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+   judged legally invalid or ineffective under applicable law, then the Waiver
+   shall be preserved to the maximum extent permitted taking into account
+   Affirmer’s express Statement of Purpose. In addition, to the extent the
+   Waiver is so judged Affirmer hereby grants to each affected person a
+   royalty-free, non transferable, non sublicensable, non exclusive,
+   irrevocable and unconditional license to exercise Affirmer’s Copyright and
+   Related Rights in the Work (i) in all territories worldwide, (ii) for the
+   maximum duration provided by applicable law or treaty (including future time
+   extensions), (iii) in any current or future medium and for any number of
+   copies, and (iv) for any purpose whatsoever, including without limitation
+   commercial, advertising or promotional purposes (the “License”). The License
+   shall be deemed effective as of the date CC0 was applied by Affirmer to the
+   Work. Should any part of the License for any reason be judged legally
+   invalid or ineffective under applicable law, such partial invalidity or
+   ineffectiveness shall not invalidate the remainder of the License, and in
+   such case Affirmer hereby affirms that he or she will not (i) exercise any
+   of his or her remaining Copyright and Related Rights in the Work or (ii)
+   assert any associated claims and causes of action with respect to the Work,
+   in either case contrary to Affirmer’s express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+   1. No trademark or patent rights held by Affirmer are waived, abandoned,
+      surrendered, licensed or otherwise affected by this document.
+   2. Affirmer offers the Work as-is and makes no representations or warranties
+      of any kind concerning the Work, express, implied, statutory or
+      otherwise, including without limitation warranties of title,
+      merchantability, fitness for a particular purpose, non infringement, or
+      the absence of latent or other defects, accuracy, or the present or
+      absence of errors, whether or not discoverable, all to the greatest
+      extent permissible under applicable law.
+   3. Affirmer disclaims responsibility for clearing rights of other persons
+      that may apply to the Work or any use thereof, including without
+      limitation any person’s Copyright and Related Rights in the Work.
+      Further, Affirmer disclaims responsibility for obtaining any necessary
+      consents, permissions or other rights required for any use of the Work.
+   4. Affirmer understands and acknowledges that Creative Commons is not a
+      party to this document and has no duty or obligation with respect to this
+      CC0 or use of the Work.
+
+For more information, please see
+http://creativecommons.org/publicdomain/zero/1.0/.

plugins/postcss-base-plugin/README.md

@@ -0,0 +1,3 @@
+# PostCSS Base Plugin [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">][postcss]
+
+<!-- TODO -->

plugins/postcss-base-plugin/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@csstools/postcss-base-plugin",
+  "private": "true",
+  "version": "0.0.0",
+  "description": "A base plugin",
+  "author": "Jonathan Neal <jonathantneal@hotmail.com>",
+  "license": "CC0-1.0",
+  "engines": {
+    "node": "^12 || ^14 || >=16"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "CHANGELOG.md",
+    "INSTALL.md",
+    "LICENSE.md",
+    "README.md",
+    "dist"
+  ],
+  "bin": {
+    "postcss-base-plugin": "dist/cli.mjs"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build --if-present && npm run test --if-present",
+    "lint": "eslint src/**/*.ts",
+    "test": "postcss-tape && bash ./test/cli/test.sh",
+    "build": "rollup -c ../../rollup/default.ts.js",
+    "stryker": "stryker run --logLevel error"
+  },
+  "devDependencies": {
+    "@csstools/base-cli": "^0.1.0",
+    "postcss": "^8.3.6",
+    "postcss-tape": "^6.0.1"
+  },
+  "peerDependencies": {
+    "postcss": "^8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/csstools/postcss-plugins.git",
+    "directory": "plugins/postcss-base-plugin"
+  }
+}

plugins/postcss-base-plugin/src/cli.ts

@@ -0,0 +1,16 @@
+import plugin from '@csstools/postcss-base-plugin';
+import { cli, helpTextLogger } from '@csstools/base-cli';
+
+cli(
+	plugin,
+	['color', 'another_option'],
+	helpTextLogger(
+		'postcss-base-plugin-cli',
+		'Base Plugin',
+		'An example plugin CLI',
+		{
+			color: 'A CSS color',
+			another_option: true,
+		},
+	),
+);

plugins/postcss-base-plugin/src/index.ts

@@ -0,0 +1,21 @@
+import type { PluginCreator } from 'postcss';
+
+const creator: PluginCreator<{ color: string }> = (opts?: { color: string }) => {
+	return {
+		postcssPlugin: 'postcss-base-plugin',
+		Declaration(decl) {
+			if (decl.value === 'red') {
+				if (opts?.color) {
+					decl.value = opts.color;
+				} else {
+					decl.value = 'blue';
+				}
+			}
+		},
+	};
+};
+
+creator.postcss = true;
+
+export default creator;
+

plugins/postcss-base-plugin/stryker.conf.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "../../node_modules/@stryker-mutator/core/schema/stryker-schema.json",
+  "mutate": [
+    "src/**/*.ts"
+  ],
+  "buildCommand": "npm run build",
+  "testRunner": "command",
+  "coverageAnalysis": "perTest",
+  "tempDirName": "../../.stryker-tmp",
+  "commandRunner": {
+    "command": "npm run test:tape"
+  },
+  "thresholds": {
+    "high": 100,
+    "low": 100,
+    "break": 100
+  },
+  "inPlace": true
+}

plugins/postcss-base-plugin/test/basic.color.expect.css

@@ -0,0 +1,7 @@
+.foo {
+	color: purple;
+}
+
+.baz {
+	color: green;
+}

plugins/postcss-base-plugin/test/basic.css

@@ -0,0 +1,7 @@
+.foo {
+	color: red;
+}
+
+.baz {
+	color: green;
+}

plugins/postcss-base-plugin/test/basic.expect.css

@@ -0,0 +1,7 @@
+.foo {
+	color: blue;
+}
+
+.baz {
+	color: green;
+}

plugins/postcss-base-plugin/test/cli/basic.color.expect.css

@@ -0,0 +1,3 @@
+.foo {
+	color: red;
+}

plugins/postcss-base-plugin/test/cli/basic.css

@@ -0,0 +1,3 @@
+.foo {
+	color: blue;
+}