@digigov/postcss-banner 0.3.8

package/CHANGELOG.json

@@ -0,0 +1,17 @@
+{
+  "name": "@digigov/postcss-banner",
+  "entries": [
+    {
+      "version": "0.3.8",
+      "tag": "@digigov/postcss-banner_v0.3.8",
+      "date": "Thu, 30 Dec 2021 12:54:03 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Initial release for forked postcss-banner plugin"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log - @digigov/postcss-banner
+
+This log was last generated on Thu, 30 Dec 2021 12:54:03 GMT and should not be manually modified.
+
+## 0.3.8
+Thu, 30 Dec 2021 12:54:03 GMT
+
+### Patches
+
+- Initial release for forked postcss-banner plugin
+

package/README.md

@@ -0,0 +1,101 @@
+# @digigov/postcss-banner
+
+`postcss-banner` plugin to add text banner and footer to resulting file.
+
+## Usage
+
+* Asterisks to beginning of line are added automatically (use `inline: false` to disable)
+* Bang isn't added automatically (use `important: true` to enable)    
+
+Add PostCSS Banner to your build tool:
+
+```sh
+npm install --save-dev postcss postcss-banner
+```
+
+Set `banner` and/or `footer` properties to add banner and/or footer to your
+resulting css (so use after minifier).
+
+Example:
+
+```js
+postcss(require('postcss-banner')({banner: 'banner'}))
+```
+
+yields
+
+```css
+/*
+ * banner
+ */
+.foo {
+}
+```
+
+Value will be converted to string and wrapped with spaces by default.
+Set `inline` to `true` to render the comment in a single line.
+
+Example:
+
+```js
+var postcss = require('gulp-postcss');
+var postcssBanner = require('postcss-banner');
+
+var banner = 'single line comment';
+
+gulp.task('css', function () {
+  return gulp.src('./css/src/*.css')
+    .pipe(postcss(
+      [
+        postcssBanner({
+          banner: banner,
+          inline: true
+        })
+      ]))
+    .pipe(gulp.dest('./css'));
+});
+```
+
+yields
+
+```css
+/* single line comment */
+.foo {
+}
+```
+
+## Options
+
+### `banner`
+
+Type: `String`
+
+The string will be converted in a css comment and put at the
+beginning of the css file.
+
+### `footer`
+
+Type: `String`
+
+The string will be converted in a css comment and put at the
+end of the css file.
+
+### `inline`
+
+Type: `Boolean`
+
+Default: `false`
+
+Render the banner all in one line.
+
+### `important`
+
+Type: `Boolean`
+
+Default: `false`
+
+Add a bang to the comment. (eg. `/*! banner v.0.0.1 */`)
+
+NOTE: Important css comments are generally preserved from being removed
+during a minification process.
+

package/index.js

@@ -0,0 +1,34 @@
+module.exports = (opts = {}) => {
+  function makeComment(banner) {
+    const bang = opts.important ? '!' : '';
+
+    if (opts.inline) {
+      return `/*${bang} ${banner} */`;
+    }
+    return `/*${bang}
+${banner.replace(/^|\n/g, '$& * ')}
+ */`;
+  }
+
+  return {
+    postcssPlugin: 'postcss-banner',
+    Once(css) {
+      if ('banner' in opts) {
+        css.prepend(makeComment(opts.banner));
+
+        // New line after banner
+        if (css.nodes[1]) {
+          // eslint-disable-next-line no-param-reassign
+          css.nodes[1].raws.before = '\n';
+        }
+      }
+
+      if ('footer' in opts) {
+        css.append(makeComment(opts.footer));
+        // eslint-disable-next-line no-param-reassign
+        css.nodes[css.nodes.length - 1].raws.before = '\n';
+      }
+    },
+  };
+};
+module.exports.postcss = true;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@digigov/postcss-banner",
+  "version": "0.3.8",
+  "description": "PostCSS plugin to add text banner to resulting file",
+  "keywords": [
+    "postcss",
+    "css",
+    "postcssplugin",
+    "banner",
+    "footer"
+  ],
+  "author": "GRNET Devs",
+  "files": [
+    "index.js"
+  ],
+  "peerDependencies": {
+    "postcss": "8.2.6"
+  },
+  "devDependencies": {
+    "chai": "4",
+    "eslint": "~7.24.0",
+    "eslint-config-airbnb-base": "^14.1.0",
+    "eslint-plugin-import": "2.20.1",
+    "mocha": "5",
+    "prettier": "~2.2.1",
+    "@digigov/cli-lint": "0.5.25"
+  },
+  "scripts": {
+    "test": "eslint *.js test/*.js && mocha"
+  }
+}