weasels - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

index.d.ts

@@ -1,1 +0,4 @@
-export var weasels: string[]
+/**
+ * List of *many* English, both British and American, weasel words.
+ */
+export const weasels: string[]

index.js

@@ -1,2 +0,5 @@
-export var weasels = [
+/**
+ * List of *many* English, both British and American, weasel words.
+ */
+export const weasels = [
   'a lot',
@@ -3,0 +6,0 @@ 'about',

package.json

 {
   "name": "weasels",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "List of (possible) English weasel words",
@@ -30,22 +30,20 @@ "license": "MIT",
   "devDependencies": {
-    "@types/tape": "^4.0.0",
+    "@types/node": "^18.0.0",
     "c8": "^7.0.0",
     "plain-text-data-to-json": "^2.0.0",
     "prettier": "^2.0.0",
-    "remark-cli": "^9.0.0",
-    "remark-preset-wooorm": "^8.0.0",
-    "rimraf": "^3.0.0",
-    "tape": "^5.0.0",
+    "remark-cli": "^11.0.0",
+    "remark-preset-wooorm": "^9.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^4.0.0",
-    "xo": "^0.38.0"
+    "xo": "^0.52.0"
   },
   "scripts": {
     "prepack": "npm run build && npm run format",
-    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
-    "generate": "node build",
+    "generate": "node build.js",
+    "build": "tsc --build --clean && tsc --build && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
-    "test-api": "node test.js",
-    "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
-    "test": "npm run generate && npm run build && npm run format && npm run test-coverage"
+    "test-api": "node --conditions development test.js",
+    "test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
@@ -61,8 +59,3 @@ "prettier": {
   "xo": {
-    "prettier": true,
-    "rules": {
-      "import/no-mutable-exports": "off",
-      "no-var": "off",
-      "prefer-arrow-callback": "off"
-    }
+    "prettier": true
   },
@@ -69,0 +62,0 @@ "remarkConfig": {

readme.md

@@ -10,9 +10,31 @@ # weasels
 
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`weasels`](#weasels-1)
+*   [Data](#data)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [Security](#security)
+*   [License](#license)
+
+## What is this?
+
+This package exposes a list of [weasel words][wiki].
+
+## When should I use this?
+
+Use this when you want to do fun things with natural language.
+
 ## Install
 
-This package is ESM only: Node 12+ is needed to use it and it must be `import`ed
-instead of `require`d.
+This package is [ESM only][esm].
+In Node.js (version 14.14+, 16.0+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -22,2 +44,16 @@ npm install weasels
 
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import {weasels} from 'https://esm.sh/weasels@2'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import {weasels} from 'https://esm.sh/weasels@2?bundle'
+</script>
+```
+
 ## Use
@@ -50,3 +86,3 @@
 
-This package exports the following identifiers: `weasels`.
+This package exports the identifier `weasels`.
 There is no default export.
@@ -56,5 +92,5 @@
 
-*Reportedly*, **weasels** exposes a list of strings (`Array.<string>`).
+*Reportedly*, **weasels** exposes a list of strings (`Array<string>`).
 
-## Support
+## Data
 
@@ -64,20 +100,40 @@ `weasels` supports *several* weasel words and phrases.
 
-Note that the words listed in **weasels** *might* or, in fact, *might* not be
-weasels.
+> 👉 **Note**: that the words listed in **weasels** *might* or, in fact,
+> *might* not be weasels.
 
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports no additional types.
+
+## Compatibility
+
+This package is at least compatible with all maintained versions of Node.js.
+As of now, that is Node.js 14.14+ and 16.0+.
+It also works in Deno and modern browsers.
+
 ## Related
 
 *   [`buzzwords`](https://github.com/words/buzzwords)
-    — List of buzzwords
+    — list of buzzwords
 *   [`dale-chall`](https://github.com/words/dale-chall)
-    — List of familiar American-English words (1995)
+    — list of familiar American-English words (1995)
 *   [`fillers`](https://github.com/words/fillers)
-    — List of filler words
+    — list of filler words
 *   [`hedges`](https://github.com/words/hedges)
-    — List of hedge words
+    — list of hedge words
 *   [`profanities`](https://github.com/words/profanities)
-    — List of profane words
+    — list of profane words
 *   [`spache`](https://github.com/words/spache)
-    — List of simple American-English words (1974)
+    — list of simple American-English words (1974)
 
+## Contribute
+
+Yes please!
+See [How to Contribute to Open Source][contribute].
+
+## Security
+
+This package is safe.
+
 ## License
@@ -107,2 +163,10 @@
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[typescript]: https://www.typescriptlang.org
+
+[contribute]: https://opensource.guide/how-to-contribute/
+
 [license]: license
@@ -113,1 +177,3 @@
 [data]: data.txt
+
+[wiki]: https://en.wikipedia.org/wiki/Weasel_word

Fixed alerts

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

8171

19.79%

Dev dependency count

9

-18.18%

Lines of code

125

5.04%

Number of lines in readme file

173

61.68%

Number of medium supply chain risk alerts

0

-100%

No dependency changes