css-list-helpers - npm Package Compare versions

Comparing version 1.0.1 to 2.0.0

CHANGELOG.md

@@ -0,1 +1,6 @@
+## 2.0.0
+- **Breaking:** Remove tcomb dependency (use `typeof` instead). The only breaking change about this is that it will provide different error messages, which could potentially break existing implementations. Most people should be able to upgrade w/o changes to their code.
+- Convert source code into TypeScript.
+- Provide TypeScript-generated type definitions.
+
 ## 1.0.1
@@ -2,0 +7,0 @@ - Fix calling split w/o options.

package.json

 {
   "name": "css-list-helpers",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Helper methods for splitting CSS lists (e.g., spaces, commas).",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "npm run cover && npm run check-coverage",
-    "cover": "istanbul cover test/index.js",
-    "check-coverage": "istanbul check-coverage"
+    "clean": "rimraf coverage dist *.log css-list-helpers-*",
+    "codecov": "codecov -f coverage/lcov.info",
+    "prebuild": "npm run clean && npm run lint",
+    "build": "tsc",
+    "prebuild:watch": "npm run prebuild",
+    "build:watch": "tsc --watch",
+    "lint": "tslint --project tsconfig.test.json",
+    "pretest": "npm run build -- --project tsconfig.test.json",
+    "test": "nyc ava --verbose",
+    "watch": "concurrently \"npm run build:watch\" \"npm test -- --watch\"",
+    "prepack": "npm test && npm run build"
   },
+  "nyc": {
+    "lines": 100,
+    "statements": 100,
+    "functions": 100,
+    "branches": 100,
+    "include": [
+      "dist/**/*.js"
+    ],
+    "exclude": [
+      "dist/**/*.test.js"
+    ],
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "cache": true,
+    "all": true,
+    "check-coverage": true
+  },
   "repository": {
@@ -29,9 +57,10 @@ "type": "git",
   "homepage": "https://github.com/jedmao/css-list-helpers#readme",
-  "dependencies": {
-    "tcomb": "^2.5.0"
-  },
   "devDependencies": {
-    "istanbul": "^0.3.21",
-    "tape": "^4.2.0"
+    "ava": "^0.25.0",
+    "concurrently": "^3.5.1",
+    "nyc": "^11.7.1",
+    "rimraf": "^2.6.2",
+    "tslint": "^5.10.0",
+    "typescript": "^2.8.3"
   }
 }

README.md

@@ -6,2 +6,3 @@ # css-list-helpers
 [![Travis Build Status](https://img.shields.io/travis/jedmao/css-list-helpers.svg?label=unix)](https://travis-ci.org/jedmao/css-list-helpers)
+[![codecov](https://codecov.io/gh/jedmao/css-list-helpers/branch/master/graph/badge.svg)](https://codecov.io/gh/jedmao/css-list-helpers)
 
@@ -22,7 +23,26 @@ [![npm](https://nodei.co/npm/css-list-helpers.svg?downloads=true)](https://nodei.co/npm/css-list-helpers/)
 var listHelpers = require('css-list-helpers');
-listHelpers.splitBySpaces(' 0 a(b / c) "d e" ');   // ['0', 'a(b / c)', '"d e"']
-listHelpers.splitByCommas(' 0, a(b / c), "d e" '); // ['0', 'a(b / c)', '"d e"']
-listHelpers.split('a/fn(b / c)', ['/']);           // ['a', 'fn(b / c)']
+
+listHelpers.splitBySpaces(' 0 a(b / c) "d e" ');
+// ['0', 'a(b / c)', '"d e"']
+
+listHelpers.splitByCommas(' 0, a(b / c), "d e" ');
+// ['0', 'a(b / c)', '"d e"']
+
+listHelpers.split('a/fn(b / c)', ['/']);
+// ['a', 'fn(b / c)']
 ```
 
+### ES6/2015 import
+
+```ts
+import * as listHelpers from 'css-list-helpers';
+```
+
+## Docs
+
+This project provides first-class TypeScript support via generated TypeScript
+definitions, included with the package. As such, you shouldn't have to
+look-up documentation in your editor, so long as your editor supports
+TypeScript.
+
 ## Testing
@@ -29,0 +49,0 @@

New 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

8333

increased by72.03%

Dependency count

0

decreased by-100%

Number of package files

6

increased by20%

Lines of code

134

increased by94.2%

Number of lines in readme file

53

increased by60.61%

Worsened metrics

Dev dependency count

6

increased by200%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedtcomb@^2.5.0

• - Removedtcomb@2.7.0(transitive)