@videinfra/static-website-builder 1.3.2 → 1.4.3

package/CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.4.3] - 2022-03-08
+### Fixed
+- Fixed negative glob paths not working
+
+## [1.4.2] - 2021-08-27
+### Fixed
+- Fixed postcss-ignore-plugin only removing and adding content in unrelated files
+
+## [1.4.1] - 2021-05-20
+### Fixed
+- Enabled postcss-ignore-plugin only when cssnano is used
+
+## [1.4.0] - 2021-05-20
+### Added
+- Added postcss-ignore-plugin
+
 ## [1.3.2] - 2021-04-07
 ### Added
 - Added gulp-dependents plugin to the .scss files for faster builds

package/lib/globs-helper.js

@@ -22,7 +22,10 @@ class GlobObject {
             if (this.pathsArr.length) {
                 this.map((basePath) => {
                     return pathsArr.map((subPath) => {
-                        return path.join(basePath, subPath);
+                        // If subpath starts with specia character "!" then prepend that to the begining of full paths
+                        const negativePath = subPath[0] === '!' ? '!' : '';
+                        const subPathNormalized = negativePath ? subPath.substr(1) : subPath;
+                        return negativePath + path.join(basePath, subPathNormalized);
                     });
                 });
             } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "1.3.2",
+  "version": "1.4.3",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {
@@ -26,6 +26,7 @@
   "dependencies": {
     "@babel/core": "^7.12.3",
     "@babel/preset-env": "^7.12.1",
+    "autoprefixer": "^9.6.1",
     "babel-loader": "^8.2.1",
     "browser-sync": "^2.26.13",
     "chalk": "4.0.0",
@@ -34,21 +35,18 @@
     "cssnano": "^4.1.10",
     "del": "^5.1.0",
     "gulp": "^4.0.2",
-    "gulp-autoprefixer": "^7.0.1",
     "gulp-cached": "^1.1.1",
     "gulp-data": "^1.3.1",
-    "gulp-debug": "^4.0.0",
     "gulp-dependents": "^1.2.5",
     "gulp-htmlmin": "^5.0.1",
     "gulp-if": "^3.0.0",
     "gulp-ignore": "^3.0.0",
     "gulp-plumber": "^1.2.1",
     "gulp-postcss": "^8.0.0",
-    "gulp-remember": "^1.0.1",
     "gulp-sass": "^4.1.0",
     "gulp-sizereport": "^1.2.1",
-    "gulp-sourcemaps": "^2.6.5",
-    "gulp-svgmin": "^2.2.0",
+    "gulp-sourcemaps": "^3.0.0",
+    "gulp-svgmin": "^3.0.0",
     "gulp-svgstore": "^7.0.1",
     "gulp-twig": "^1.2.0",
     "minimist": "^1.2.5",

package/tasks/data/data-loader-js.js

@@ -1,5 +1,5 @@
-module.exports = function dataLoaderJS (fileName) {
-    // Re-load script each time this function is called
-    delete require.cache[require.resolve(fileName)];
-    return require(fileName);
-};
+module.exports = function dataLoaderJS (fileName) {
+    // Re-load script each time this function is called
+    delete require.cache[require.resolve(fileName)];
+    return require(fileName);
+};

package/tasks/stylesheets/preprocess-config.js

@@ -2,7 +2,6 @@ const cssnano = require('cssnano');
 const autoprefixer = require('autoprefixer');
 const find = require('lodash/find');
 
-
 /**
  * Modify configuration
  *
@@ -17,19 +16,29 @@ module.exports = function processStylesheetsConfig (config, fullConfig) {
     }
 
     if (config && config.postcss) {
-        config.postcss.plugins = config.postcss.plugins || {};
+        config.postcss.plugins = config.postcss.plugins || [];
 
         // Add autoprefixer
         if (config.autoprefixer && !find(config.postcss.plugins, {'postcssPlugin': 'autoprefixer'})) {
             config.postcss.plugins.push(autoprefixer(config.autoprefixer));
         }
 
-        // Add CSS nano
+        if (config.cssnano) {
+            // Add ignore plugin only if there is nano / minification
+            config.postcss.plugins.unshift(require('../../vendor/postcss-ignore-plugin/dist/remove').default);
+        }
+
+        // // Add CSS nano
         if (config.cssnano && !find(config.postcss.plugins, {'postcssPlugin': 'cssnano'})) {
             config.postcss.plugins.push(cssnano({
                 preset: [config.cssnano.preset, config.cssnano]
             }));
         }
+
+        if (config.cssnano) {
+            // Add ignore plugin only if there is nano / minification
+            config.postcss.plugins.push(require('../../vendor/postcss-ignore-plugin/dist/add').default);
+        }
     }
 
     return config;

package/tests/glob-helper.test.js

@@ -84,6 +84,11 @@ test('glob map', () => {
     expect(output2).toEqual(['/a/some/folder/b', '/a/other/folder/b']);
 });
 
+test('glob negative', () => {
+    const output = glob.paths('/some/folder').paths('!/assets/**/*.*').generate();
+    expect(output).toEqual(['!/some/folder/assets/**/*.*']);
+});
+
 test('glob generate', () => {
     const output = glob.generate(
         glob.paths(['/a', '/b']).allFiles(),

package/vendor/postcss-ignore-plugin/README.md

@@ -0,0 +1,124 @@
+# postcss-ignore-plugin
+
+![CI tests](https://github.com/anikethsaha/postcss-ignore-plugin/workflows/CI%20tests/badge.svg?branch=master&event=push)
+![CI Integration tests](https://github.com/anikethsaha/postcss-ignore-plugin/workflows/CI%20Integration%20tests/badge.svg?branch=master&event=push)
+
+Ignore postcss plugins operations in lines using comments
+
+## Getting started
+
+`$ yarn add postcss-ignore-plugin -D`
+
+and add this it in your `postcss` config
+
+```js
+// postcss.config.js
+module.exports = {
+  plugins: [
+    require('postcss-ignore-plugin/remove'), // Important to keep this at the top of the plugins
+    require('cssnano'),
+    require('autoprefixer'),
+    require('stylelint'),
+    require('postcss-ignore-plugin/add'), // Important to keep it at the end
+  ],
+};
+```
+
+Now use the following comments whenever you want to ignore any operation for other plugins
+
+- for ignoring a particular line or declaration (css properties) inside of css rule
+
+  ```css
+  /* postcss-ignore-line */
+  ```
+
+  > Dont use `/* postcss-ignore-line */` for css rules
+
+- for ignoring a whole rule
+
+  ```css
+  /* postcss-ignore */
+  ```
+
+## How it works
+
+Currently we support only for declaration statement, that mean you can add this comment over CSS declaration line not over the selector list in Rule declaration
+
+`example`
+
+```css
+.classname {
+  margin: auto;
+  /* postcss-ignore-line */
+  color: red;
+}
+
+/* postcss-ignore */
+.classname {
+  margin: auto;
+  color: red;
+}
+
+@media screen and (min-width: 480px) {
+  ul {
+    /* postcss-ignore-line */
+    list-style: none;
+  }
+
+  /* postcss-ignore */
+  p {
+    font-size: 10px;
+  }
+}
+```
+
+It simple remove the next line before running the other plugins and then add them at the end.
+
+## Rules
+
+Use [`stylelint-postcss-ignore`](https://github.com/anikethsaha/stylelint-postcss-ignore) for rules regarding this plugin 's better use
+
+## Tests
+
+this plugins are tested with
+
+- cssnano
+- Autoprefixer
+- postcss-preset-env
+- stylelint
+- some custom plugins meant to fail the op
+- Indivial tests for each plugins
+
+> There are not many test cases. More will be added soon
+
+## FAQ
+
+- **Can we ignore a whole css `atrules` (like media queries) ?**
+
+  No, you need to use `/* postcss-ignore */` before each rule inside the `atrules`
+
+- **will those ignore rules/properties (declarations) will come back to there original position after all operations?**
+
+  No, both. rules and atrules will append at the end. declarations (rules's properties) will append at the rule itself. and if you have used `/* postcss-ignore */` for a rule inside of atrules, it will get appended for that atrule at the end
+
+- **Does it effect the performance like the build time?**
+
+  Yes _(sometimes for code with many ignore comments )_, but not at a huge level. It slightly decreases the performance as there are 2-3 nested looks so you can notices some issue with huge code with many ignore comments
+
+## Contributing Guidelines
+
+Simply click on this
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/anikethsaha/postcss-ignore-plugin)
+
+and starting working in it !
+
+**OR**
+
+- clone the repo
+- Install the dependenices `yarn install`
+- Build the code `yarn build`
+- run the tests before working `yarn test:only` and `yarn test:integrations`
+- start working
+
+If you add a new feature or did some breaking change , update [`stylelint-postcss-ignore`](https://github.com/anikethsaha/stylelint-postcss-ignore) for consistency

package/vendor/postcss-ignore-plugin/dist/add.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _postcss = require("postcss");
+
+var _default = (0, _postcss.plugin)('postcss-ignore-plugin-add', () => {
+  return (root, result) => {
+    if (result.messages.type !== 'postcss-ignore-plugin') {
+      return;
+    }
+
+    const msgs = result.messages;
+    let declToAdd = [],
+        rulesToAdd = [];
+    msgs.forEach(msg => {
+      if (msg['postcss-ignore-plugin'] !== undefined) {
+        msg['postcss-ignore-plugin'].ignoredLineData.forEach(ignoreData => {
+          if (root.source.input.file === ignoreData.fileName) {
+            declToAdd.push(ignoreData);
+          }
+        });
+        msg['postcss-ignore-plugin'].ignoreRulesData.forEach(ignoredRule => {
+          if (root.source.input.file === ignoredRule.fileName) {
+            rulesToAdd.push(ignoredRule);
+          }
+        });
+      }
+    }); // add decl to  atrules
+
+    root.walkAtRules(atRules => {
+      declToAdd.forEach(decl => {
+        if (decl.atRule !== undefined && atRules.name === decl.atRule.name && atRules.params === decl.atRule.params) {
+          atRules.walkRules(rules => {
+            if (rules.selector === decl.selector) {
+              rules.append({
+                prop: decl.prop,
+                value: decl.value
+              });
+            }
+          });
+        }
+      });
+    }); // add decl only those with no atrules
+
+    root.walkRules(rules => {
+      declToAdd.forEach(decl => {
+        if (rules.selector === decl.selector && decl.atRule === undefined) {
+          rules.append({
+            prop: decl.prop,
+            value: decl.value
+          });
+        }
+      });
+    }); // add rules
+
+    rulesToAdd = rulesToAdd.filter(rule => {
+      if (rule.parent.type !== 'atrule') {
+        root.append(rule.rule);
+        return false;
+      }
+
+      return true;
+    }); // add rules to artules
+
+    root.walkAtRules(atrule => {
+      rulesToAdd = rulesToAdd.filter(rule => {
+        if (atrule.params === rule.parent.params) {
+          atrule.append(rule.rule);
+          return false;
+        }
+
+        return true;
+      });
+    });
+  };
+});
+
+exports.default = _default;

package/vendor/postcss-ignore-plugin/dist/remove.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _postcss = require("postcss");
+
+var _default = (0, _postcss.plugin)('postcss-ignore-plugin-remove', () => {
+  let ignoredLineData = [];
+  let commentsIgnoredRule = [];
+  let ignoreRulesData = []; // Work with options here
+
+  return (root, result) => {
+    // Transform CSS AST here
+    root.walkRules(rule => {
+      // Transform each rule here
+      rule.walkComments(comment => {
+        if (comment.text === 'postcss-ignore-line') {
+          let commentData = {
+            fileName: comment.source.input.file,
+            commentedLine: comment.source.start.line,
+            ignoredLine: comment.source.start.line + 1
+          };
+          comment.remove();
+          ignoredLineData.push(commentData);
+        }
+      });
+    });
+    root.walkComments(comment => {
+      if (comment.text === 'postcss-ignore') {
+        commentsIgnoredRule.push({
+          fileName: comment.source.input.file,
+          commentLine: comment.source.start,
+          ruleIgnoreLineNo: comment.source.start.line + 1
+        });
+
+        comment.remove();
+      }
+    });
+    root.walkRules(rule => {
+      rule.walkDecls(decl => {
+        const declLine = decl.source.start.line;
+        ignoredLineData.forEach(ignoreData => {
+          if (decl.source.input.file === ignoreData.fileName && ignoreData.ignoredLine === declLine) {
+            ignoreData.selector = decl.parent.selector;
+            ignoreData.prop = decl.prop;
+            ignoreData.value = decl.value;
+
+            if (decl.parent.parent.type === 'atrule') {
+              ignoreData.atRule = {
+                name: decl.parent.parent.name,
+                params: decl.parent.parent.params
+              };
+            }
+
+            decl.remove();
+          }
+        });
+      });
+      commentsIgnoredRule.forEach(data => {
+        if (rule.source.input.file === data.fileName && rule.source.start.line === data.ruleIgnoreLineNo) {
+          ignoreRulesData.push({
+            rule,
+            parent: rule.parent,
+            fileName: data.fileName
+          });
+          rule.remove();
+        }
+      });
+    });
+    result.messages.type = 'postcss-ignore-plugin';
+    result.messages.push({
+      'postcss-ignore-plugin': {
+        ignoredLineData,
+        ignoreRulesData
+      }
+    });
+  };
+});
+
+exports.default = _default;