require-extension-hooks - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

changelog.md

 # Change Log
 
+## 0.3.1
+- Include should be either-y.
+
 ## 0.3.0
@@ -4,0 +7,0 @@ - Fixed a bug where the plugin option did not pass configuration options [5](https://github.com/jackmellis/require-extension-hooks/issues/5)

package.json

 {
   "name": "require-extension-hooks",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Add hooks for js extension types",
@@ -26,7 +26,9 @@ "main": "src/index.js",
     "minimatch": "^3.0.4",
+    "mkdirp": "^0.5.1",
     "source-map": "^0.5.6"
   },
   "devDependencies": {
-    "ava": "^0.20.0"
+    "ava": "^0.20.0",
+    "inspect-process": "^0.5.0"
   }
 }

README.md

@@ -28,5 +28,11 @@ # require-extension-hooks
 
-### hook.shift(fn)  
+### hook.unshift(fn)  
 Inserts a function at the start of the queue of hooks for this extension.  
 
+### hook.pop()
+Removes the latest hook from the current extension.
+
+### hook.shift()
+Removes the first hook from the current extension.
+
 ### hook.splice(index, remove, fn1, fn2, ...)  
@@ -39,7 +45,10 @@ Acts like [].splice() for inserting and removing functions.
 ### hook.plugin(name | fn)  
-Loads a plugin. The plugin can either be a partial name (i.e. for *require-extension-hooks-vue* you can just type `hook.plugin('vue')`), the full name of a plugin (i.e. `hook.plugin('require-extension-hooks-vue')`) or a direct function (i.e. `hook.plugin(function(config){}`).  
+Loads a plugin.
+
+The plugin can either be a partial name (i.e. for *require-extension-hooks-vue* you can just type `hook.plugin('vue')`), the full name of a plugin (i.e. `hook.plugin('require-extension-hooks-vue')`) or a direct function (i.e. `hook.plugin(function(config){}`).  
+
 The plugin is automatically added to the hook queue. You can move it to the start of the queue by calling `hook.plugin('xxx').unshift()`.
 
 ### include(pattern | fn)
-Restricts the hook to only run based on the provided pattern. The argument can either a function (that takes the same configuration options as the hook itself), or a **glob** pattern that is matched against the filename.
+Restricts the hook to only run based on the provided pattern. The argument can be either a function (that takes the same configuration options as the hook itself), or a **glob** pattern that is matched against the filename.
 ```js
@@ -52,3 +61,3 @@ // these 2 examples will both only run for files in the node_modules folder
 ### exclude(pattern | fn)
-Restricts the hook to skip files that do not match the provided pattern. The argument can either a function (that takes the same configuration options as the hook itself), or a **glob** pattern that is matched against the filename.
+Restricts the hook to skip files that do not match the provided pattern. The argument can be either a function (that takes the same configuration options as the hook itself), or a **glob** pattern that is matched against the filename.
 ```js
@@ -63,2 +72,7 @@ // these 2 examples will both EXCLUDE any files from the node_modules folder
 ### config  
+```js
+hooks('js').push(function ({filename, content, stop, cancel, sourceMap, hook}) {
+  ...
+})
+```
 A hook function takes a config object as its only argument. This object contains the following options:  
@@ -81,5 +95,5 @@ #### filename
 hooks('.custom').push(function ({content, hook}) {
-  let {javascriptPart, typescriptPart} = extractStuffFromContent(content);
+  let {javascriptPart, typescriptPart} = extractStuff(content);
   let transpiledTypescriptPart = hook('.ts', typescriptPart);
-  return `${javascriptPart}\n${typescriptPart}`;
+  return `${javascriptPart}\n${transpiledTypescriptPart}`;
 })
@@ -89,4 +103,4 @@ ```
 - `String` - assumed to be the content you want to parse.
-- `{content : String}` - same as passing content directly
-- `{content : String, filename : String}` - passes the content to the hook but with a custom filename
+- `{content : String}` - same as passing content directly.
+- `{content : String, filename : String}` - passes the content to the hook but with a custom filename.
 - `{filename : String}` - pass in a custom filename and it will read in and transpile that file's content.
@@ -93,0 +107,0 @@

src/api.js

@@ -7,3 +7,4 @@ const minimatch = require('minimatch');
     this._plugin = null;
-    this._filter = [];
+    this._include = [];
+    this._exclude = [];
   }
@@ -16,6 +17,10 @@ push(fn){
     if (fn && typeof fn === 'function'){
-      if (this._filter.length){
+      if (this._include.length){
         let fn2 = fn;
-        fn = config => this._filter.every(fn => fn(config)) && fn2(config);
+        fn = config => this._include.some(fn => fn(config)) && fn2(config);
       }
+      if (this._exclude.length){
+        let fn2 = fn;
+        fn = config => this._exclude.every(fn => !fn(config)) && fn2(config);
+      }
       this._extensions.forEach(ext => ext.push(fn));
@@ -87,6 +92,6 @@ }
       pattern = new minimatch.Minimatch(pattern);
-      this._filter.push(({filename}) => pattern.match(filename));
+      this._include.push(({filename}) => pattern.match(filename));
       break;
     case 'function':
-      this._filter.push(pattern);
+      this._include.push(pattern);
       break;
@@ -100,6 +105,6 @@ }
       pattern = new minimatch.Minimatch(pattern);
-      this._filter.push(({filename}) => !pattern.match(filename));
+      this._exclude.push(({filename}) => pattern.match(filename));
       break;
     case 'function':
-      this._filter.push(config => !pattern(config));
+      this._exclude.push(pattern);
       break;
@@ -106,0 +111,0 @@ }

src/hook.js

 const fs = require('fs');
 const path = require('path');
+const mkdirp = require('mkdirp');
+const cache = require('./cache');
+const permaCache = require('./permaCache');
+const cwd = path.resolve('.');
 const requireCache = {};
@@ -11,7 +15,19 @@ function requireIf(path){
 
-const cache = require('./cache');
+function hook(hooks, module, filename){
+  const useCache = permaCache.enabled && permaCache.match(filename);
+  if (useCache){
+    const cached = getCachedFile(filename);
+    if (cached !== false){
+      compile(module, cached, filename);
+      return;
+    }
+  }
 
-function hook(hooks, module, filename){
   const content = fs.readFileSync(filename, 'utf8');
   const transpiled = transpile(hooks, filename, content);
+
+  if (useCache){
+    setCachedFile(filename, transpiled);
+  }
+
   compile(module, transpiled, filename);
@@ -169,2 +185,31 @@ }
 
+function getCachedFilepath(filepath){
+  return path.join(
+    permaCache.path,
+    filepath.replace(permaCache.cwd, ''),
+  );
+}
+
+function getCachedFile(filepath){
+  const tmpFilepath = getCachedFilepath(filepath);
+  let tmpLastUpdated = 0;
+  try{
+    tmpLastUpdated = fs.statSync(tmpFilepath).mtimeMs;
+  }catch(e){
+    return false;
+  }
+  const lastUpdated = fs.statSync(filepath).mtimeMs;
+  if (lastUpdated >= tmpLastUpdated){
+    return false;
+  }
+  return fs.readFileSync(tmpFilepath, 'utf8');
+}
+
+function setCachedFile(filepath, content){
+  const tmpFilepath = getCachedFilepath(filepath);
+  const tmpDirname = path.dirname(tmpFilepath);
+  mkdirp.sync(tmpDirname);
+  fs.writeFileSync(tmpFilepath, content, 'utf8');
+}
+
 module.exports = hook;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17304

increased by9.04%

Lines of code

340

increased by22.3%

Number of lines in readme file

137

increased by11.38%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

5

increased by25%

Dev dependency count

2

increased by100%

Number of low supply chain risk alerts

6

increased by20%

Dependency changes

• + Addedmkdirp@^0.5.1

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)