serverless-plugin-common-excludes - npm Package Compare versions

Comparing version 3.0.1 to 4.0.0

common-excludes.js

 'use strict';
 
+const semver = require('semver');
+
 module.exports = class CommonExcludes {
 
   constructor(serverless, options) {
+    if (!semver.satisfies(serverless.version, '>= 2.32')) {
+      throw new Error('serverless-plugin-common-excludes requires serverless 2.32 or higher!');
+    }
+
     this.serverless = serverless;
@@ -15,92 +21,96 @@ this.options = options;
   addExcludes() {
-    const service = this.serverless.service;
+    const { service } = this.serverless;
 
     service.package = service.package || {};
+    service.package.patterns = service.package.patterns || [];
 
-    const exclude = service.package.exclude || [];
+    const set = new Set(service.package.patterns);
 
-    service.package.exclude = Array.from(new Set(
-      exclude.concat([
-        // common project files
-        '.gitignore',
-        '.gitconfig',
-        '.editorconfig',
-        '.eslintignore',
-        '.eslintrc',
-        '.npmrc',
-        '.nycrc',
-        '.npmignore',
-        '*coveralls.yml',
-        '.circleci/**',
-        '*circle.yml',
-        '*travis.yml',
-        '.gitlab-ci.yml',
-        '*.md',
-        '*.apib',
-        '.vscode/**',
-        'package-lock.json',
-        '.npm-upgrade.json',
-        'sonar-project.properties',
-        'sonar-coverage.info',
-        'rollup.config.*',
-        'yarn.lock',
-        // common project directories
-        'coverage/**',
-        '.nyc_output/**',
-        'docs/**',
-        'test/**',
-        'tests/**',
-        'CODEOWNERS',
-        // common things that node_modules fail to .npmignore
-        'node_modules/**/*.md',
-        'node_modules/**/*.flow',
-        'node_modules/**/*.patch',
-        'node_modules/**/*.conf',
-        'node_modules/**/*.markdown',
-        'node_modules/**/*.coffee',
-        'node_modules/**/jsdoc_conf.json',
-        'node_modules/**/*Makefile',
-        'node_modules/**/Dockerfile',
-        'node_modules/**/*.txt',
-        'node_modules/**/*.yml',
-        'node_modules/**/*.xml',
-        'node_modules/**/*.html',
-        'node_modules/**/test/**',
-        'node_modules/**/tests/**',
-        'node_modules/**/examples/**',
-        'node_modules/**/coverage/**',
-        'node_modules/**/.nyc_output/**',
-        'node_modules/**/bin/**',
-        'node_modules/**/bower.json',
-        'node_modules/**/karma.conf.js',
-        'node_modules/**/Gruntfile.js',
-        'node_modules/**/rollup.config.*',		
-        'node_modules/**/yarn.lock',
-        'node_modules/**/sonar-project.properties',	
-        'node_modules/**/package-lock.json',
-        'node_modules/**/*.d.ts',
-        'node_modules/**/*.map',
-        'node_modules/**/tsconfig.json',
-        'node_modules/**/AUTHORS',
-        'node_modules/**/CODEOWNERS',
-        'node_modules/**/OWNERS',
-        'node_modules/**/*.iml',
-        'node_module/**/*.bash_completion.in',
-        // yes, these are real
-        'node_modules/**/*.gif',
-        'node_modules/**/*.png',
-        'node_modules/**/*.jpg',
-        'node_modules/**/*.jpeg',
-        // module-specific odd things
-        'node_modules/**/winston/scratch/**',
-        'node_modules/**/sshpk/man/**',
-        'node_modules/**/bluebird/js/browser/**',
-        'node_modules/**/date-fns/docs.json',
-        'node_modules/**/aws-xray-sdk-core/doc-src/**',
-        // AWS SDK unused dist files
-        'node_modules/**/aws-sdk/dist/**',
-        'node_modules/**/aws-sdk/dist-tools/**',
-      ])
-    ));
+    [
+      // common project files
+      '!.gitignore',
+      '!.gitconfig',
+      '!.editorconfig',
+      '!.eslintignore',
+      '!.eslintrc',
+      '!.npmrc',
+      '!.nycrc',
+      '!.npmignore',
+      '!*coveralls.yml',
+      '!.circleci/**',
+      '!*circle.yml',
+      '!*travis.yml',
+      '!.gitlab-ci.yml',
+      '!*.md',
+      '!*.apib',
+      '!.vscode/**',
+      '!package-lock.json',
+      '!.npm-upgrade.json',
+      '!sonar-project.properties',
+      '!sonar-coverage.info',
+      '!rollup.config.*',
+      '!yarn.lock',
+      // common project directories
+      '!coverage/**',
+      '!.nyc_output/**',
+      '!docs/**',
+      '!test/**',
+      '!tests/**',
+      '!CODEOWNERS',
+      // common things that node_modules fail to .npmignore
+      '!node_modules/**/*.md',
+      '!node_modules/**/*.flow',
+      '!node_modules/**/*.patch',
+      '!node_modules/**/*.conf',
+      '!node_modules/**/*.markdown',
+      '!node_modules/**/*.coffee',
+      '!node_modules/**/jsdoc_conf.json',
+      '!node_modules/**/*Makefile',
+      '!node_modules/**/Dockerfile',
+      '!node_modules/**/*.txt',
+      '!node_modules/**/*.yml',
+      '!node_modules/**/*.xml',
+      '!node_modules/**/*.html',
+      '!node_modules/**/test/**',
+      '!node_modules/**/tests/**',
+      '!node_modules/**/examples/**',
+      '!node_modules/**/coverage/**',
+      '!node_modules/**/.nyc_output/**',
+      '!node_modules/**/bin/**',
+      '!node_modules/**/bower.json',
+      '!node_modules/**/karma.conf.js',
+      '!node_modules/**/Gruntfile.js',
+      '!node_modules/**/rollup.config.*',		
+      '!node_modules/**/yarn.lock',
+      '!node_modules/**/sonar-project.properties',	
+      '!node_modules/**/package-lock.json',
+      '!node_modules/**/*.d.ts',
+      '!node_modules/**/*.map',
+      '!node_modules/**/tsconfig.json',
+      '!node_modules/**/AUTHORS',
+      '!node_modules/**/CODEOWNERS',
+      '!node_modules/**/OWNERS',
+      '!node_modules/**/*.iml',
+      '!node_module/**/*.bash_completion.in',
+      // yes, these are real
+      '!node_modules/**/*.gif',
+      '!node_modules/**/*.png',
+      '!node_modules/**/*.jpg',
+      '!node_modules/**/*.jpeg',
+      // module-specific odd things
+      '!node_modules/**/winston/scratch/**',
+      '!node_modules/**/sshpk/man/**',
+      '!node_modules/**/bluebird/js/browser/**',
+      '!node_modules/**/date-fns/docs.json',
+      '!node_modules/**/aws-xray-sdk-core/doc-src/**',
+      // AWS SDK unused dist files
+      '!node_modules/**/aws-sdk/dist/**',
+      '!node_modules/**/aws-sdk/dist-tools/**',
+    ].forEach(pattern => {
+      if (set.has(pattern)) {
+        return;
+      }
+      service.package.patterns.push(pattern);
+    });
   }
 };

package.json

 {
   "name": "serverless-plugin-common-excludes",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Adds some common exclude items to your package exclude",
@@ -24,4 +24,7 @@ "main": "common-excludes.js",
   "devDependencies": {
-    "eslint": "^5.14.1"
+    "eslint": "^7.29.0"
+  },
+  "dependencies": {
+    "semver": "^7.3.5"
   }
 }

README.md

 # serverless-plugin-common-excludes
 
+4.0.0 switches to the package.patterns property instead of include/exclude
+
 > Note: This plugin no longer excludes the `aws-sdk` which is in line with AWS best practices (bring your own SDK).
@@ -4,0 +6,0 @@

No alert changes

Improved metrics

Total package byte prevSize

5241

increased by7.07%

Lines of code

107

increased by8.08%

Number of lines in readme file

28

increased by7.69%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedsemver@^7.3.5

• + Addedsemver@7.6.2(transitive)