textextensions - npm Package Compare versions

Comparing version 4.4.0 to 5.0.0-next.1590819186.b2b3bb02b9ca23983be9be55550d9d92bd618bd9

HISTORY.md

 # History
 
+## v5.0.0 2020 May 21
+
+-   Breaking Change: If you are using CommonJS, you must now do `require('textextensions').default`
+-   If you want a JSON file, it is available via `textextensions/list.json`, and CDN access is available via https://unpkg.com/textextensions/list.json
+-   Converted to TypeScript
+-   Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
+-   Minimum required node version changed back from `node: >=10` to `node: >=0.8` to support some users still on very old versions
+
 ## v4.4.0 2020 May 22
@@ -4,0 +12,0 @@

package.json

 {
   "title": "The Definitive List of Text Extensions",
   "name": "textextensions",
-  "version": "4.4.0",
+  "version": "5.0.0-next.1590819186.b2b3bb02b9ca23983be9be55550d9d92bd618bd9",
   "description": "A package that contains an array of every single file extension there is for text files",
@@ -10,8 +10,12 @@ "homepage": "https://github.com/bevry/textextensions",
     "browser",
+    "export-default",
     "extensions",
-    "json",
+    "module",
     "node",
     "text",
     "text extensions",
-    "text-extensions"
+    "text-extensions",
+    "typed",
+    "types",
+    "typescript"
   ],
@@ -76,35 +80,78 @@ "badges": {
   "engines": {
-    "node": ">=10"
+    "node": ">=0.8"
   },
   "editions": [
     {
-      "description": "JSON",
+      "description": "TypeScript source code with Import for modules",
       "directory": "source",
-      "entry": "index.json",
+      "entry": "index.ts",
       "tags": [
-        "json"
+        "typescript",
+        "import"
       ],
+      "engines": false
+    },
+    {
+      "description": "TypeScript compiled against ES2019 for web browsers with Import for modules",
+      "directory": "edition-browsers",
+      "entry": "index.js",
+      "tags": [
+        "javascript",
+        "import"
+      ],
       "engines": {
-        "node": true,
-        "browsers": true
+        "node": false,
+        "browsers": "defaults"
       }
+    },
+    {
+      "description": "TypeScript compiled against ES5 for Node.js with Require for modules",
+      "directory": "edition-es5",
+      "entry": "index.js",
+      "tags": [
+        "javascript",
+        "es5",
+        "require"
+      ],
+      "engines": {
+        "node": "10 || 12 || 13 || 14",
+        "browsers": false
+      }
     }
   ],
+  "types": "./compiled-types/",
   "type": "commonjs",
-  "main": "source/index.json",
-  "browser": "source/index.json",
+  "main": "edition-es5/index.js",
+  "browser": "edition-browsers/index.js",
+  "module": "edition-browsers/index.js",
   "devDependencies": {
-    "@bevry/update-contributors": "^1.7.0",
+    "@bevry/update-contributors": "^1.8.0",
+    "@typescript-eslint/eslint-plugin": "^3.0.2",
+    "@typescript-eslint/parser": "^3.0.2",
     "assert-helpers": "^6.6.0",
-    "binaryextensions": "^3.0.0",
+    "binaryextensions": "^4.0.0",
+    "eslint": "^7.1.0",
+    "eslint-config-bevry": "^3.7.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-prettier": "^3.1.3",
     "kava": "^5.3.0",
+    "prettier": "^2.0.5",
     "projectz": "^2.4.0",
-    "valid-directory": "^2.1.0"
+    "surge": "^0.21.3",
+    "typedoc": "^0.17.7",
+    "typescript": "^3.9.3",
+    "valid-directory": "^2.2.0",
+    "valid-module": "^1.3.0"
   },
   "scripts": {
     "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
-    "our:compile": "echo no need for this project",
+    "our:compile": "npm run our:compile:edition-browsers && npm run our:compile:edition-es5 && npm run our:compile:types",
+    "our:compile:edition-browsers": "tsc --module ESNext --target ES2019 --outDir ./edition-browsers --project tsconfig.json && ( test ! -d edition-browsers/source || ( mv edition-browsers/source edition-temp && rm -Rf edition-browsers && mv edition-temp edition-browsers ) )",
+    "our:compile:edition-es5": "tsc --module commonjs --target ES5 --outDir ./edition-es5 --project tsconfig.json && ( test ! -d edition-es5/source || ( mv edition-es5/source edition-temp && rm -Rf edition-es5 && mv edition-temp edition-es5 ) )",
+    "our:compile:types": "tsc --project tsconfig.json --emitDeclarationOnly --declaration --declarationMap --declarationDir ./compiled-types && ( test ! -d compiled-types/source || ( mv compiled-types/source edition-temp && rm -Rf compiled-types && mv edition-temp compiled-types ) )",
     "our:deploy": "echo no need for this project",
-    "our:meta": "npm run our:meta:contributors && npm run our:meta:projectz",
+    "our:meta": "npm run our:meta:contributors && npm run our:meta:docs && npm run our:meta:projectz",
     "our:meta:contributors": "update-contributors",
+    "our:meta:docs": "npm run our:meta:docs:typedoc",
+    "our:meta:docs:typedoc": "rm -Rf ./docs && typedoc --mode file --exclude '**/+(*test*|node_modules)' --excludeExternals --name \"$npm_package_name\" --readme ./README.md --out ./docs ./source",
     "our:meta:projectz": "projectz compile",
@@ -120,6 +167,27 @@ "our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
     "our:test": "npm run our:verify && npm test",
-    "our:verify": "npm run our:verify:directory",
+    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:module && npm run our:verify:prettier",
     "our:verify:directory": "valid-directory",
-    "test": "node ./source/test.js"
+    "our:verify:eslint": "eslint --fix --ignore-pattern '**/*.d.ts' --ignore-pattern '**/vendor/' --ignore-pattern '**/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
+    "our:verify:module": "valid-module",
+    "our:verify:prettier": "prettier --write .",
+    "test": "node ./edition-es5/test.js"
+  },
+  "eslintConfig": {
+    "extends": [
+      "bevry"
+    ]
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true
+  },
+  "boundation": {
+    "minimumSupportNodeVersion": "0.8",
+    "minimumTestNodeVersion": "10",
+    "compiler": "typescript",
+    "targets": [
+      "browser",
+      "ES5"
+    ]
   }
 }

README.md

@@ -38,19 +38,24 @@ <!-- TITLE/ -->
 
-``` javascript
-console.log(require('textextensions'))
+[Complete API Documentation.](http://master.textextensions.bevry.surge.sh/docs/globals.html)
+
+```typescript
+import list from 'textextensions'
+console.log(list)
 ```
 
-Missing an extension? [Send a pull request!](https://github.com/bevry/textextensions/edit/master/source/index.json)
+```javascript
+const list = require('textextensions').default
+console.log(list)
+```
 
-Want a definitive list of binary extensions? Check out [bevry/binaryextensions](https://github.com/bevry/binaryextensions)
+JSON also available via `textextensions/list.json`
 
-Want to detect if a file is text or binary? Check out [bevry/istextorbinary](https://github.com/bevry/istextorbinary)
+CDN access available via https://unpkg.com/textextensions/list.json
 
+Missing an extension? [Send a pull request!](https://github.com/bevry/textextensions/edit/master/source/index.ts)
 
+Want a definitive list of binary extensions? Check out [bevry/binaryextensions](https://github.com/bevry/binaryextensions)
 
+Want to detect if a file is text or binary? Check out [bevry/istextorbinary](https://github.com/bevry/istextorbinary)
 
-
-
-
-
 <!-- INSTALL/ -->
@@ -63,6 +68,22 @@
 <li>Install: <code>npm install --save textextensions</code></li>
-<li>Import: <code>import * as pkg from ('textextensions')</code></li>
-<li>Require: <code>const pkg = require('textextensions')</code></li>
+<li>Import: <code>import pkg from ('textextensions')</code></li>
+<li>Require: <code>const pkg = require('textextensions').default</code></li>
 </ul>
 
+<a href="https://www.pika.dev/cdn" title="100% Native ES Modules CDN"><h3>pika</h3></a>
+
+``` html
+<script type="module">
+    import pkg from '//cdn.pika.dev/textextensions/^5.0.0'
+</script>
+```
+
+<a href="https://unpkg.com" title="unpkg is a fast, global content delivery network for everything on npm"><h3>unpkg</h3></a>
+
+``` html
+<script type="module">
+    import pkg from '//unpkg.com/textextensions@^5.0.0'
+</script>
+```
+
 <a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>
@@ -72,3 +93,3 @@
 <script type="module">
-    import * as pkg from '//dev.jspm.io/textextensions@4.4.0'
+    import pkg from '//dev.jspm.io/textextensions@5.0.0'
 </script>
@@ -81,4 +102,6 @@ ```
 
-<ul><li><code>textextensions</code> aliases <code>textextensions/source/index.json</code></li>
-<li><code>textextensions/source/index.json</code> is JSON</li></ul>
+<ul><li><code>textextensions/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
+<li><code>textextensions/edition-browsers/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_-_ECMAScript_2019" title="ECMAScript ES2019">ES2019</a> for web browsers with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
+<li><code>textextensions</code> aliases <code>textextensions/edition-es5/index.js</code></li>
+<li><code>textextensions/edition-es5/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES5 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li></ul>
 
@@ -85,0 +108,0 @@ <!-- /INSTALL -->

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

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

Improved metrics

Total package byte prevSize

36430

increased by60.55%

Number of package files

12

increased by100%

Lines of code

894

increased by208.28%

Number of lines in readme file

171

increased by15.54%

Worsened metrics

Dev dependency count

17

increased by183.33%

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes