@quartz/js-utils - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@quartz/js-utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A collection of reusable JavaScript utilities for Quartz products.",
@@ -15,3 +15,3 @@ "main": "dist/index.js",
     "build": "tsc",
-    "prepublish": "npm run build"
+    "publish": "npm run build"
   },
@@ -18,0 +18,0 @@ "repository": {

readme.md

@@ -1,3 +0,36 @@
-# JavaScript utilities
+# Quartz JavaScript utilities
 
-A collection of reusable JavaScript utilities for Quartz products.
+[![npm version](https://badge.fury.io/js/%40quartz%2Fjs-utils.svg)](https://badge.fury.io/js/%40quartz%2Fjs-utils)
+
+A collection of reusable JavaScript utilities for Quartz products, with optional TypeScript support.
+
+All functions are written in TypeScript and transpiled into ES2017 JavaScript (with type definitions).
+
+## Installation
+
+`npm i @quartz/js-utils`
+
+## Usage
+
+Import functions from the js-utils package, e.g.
+
+`import { arrayFromRange, resizeWPImage } from '@quartz/js-utils'`
+
+TypeScript hints are available if the file into which the functions are imported is a `.ts` or `.tsx` file.
+
+## Contributing
+
+Functions must be written in TypeScript whenever possible.
+
+Export one function per file with a test suite (`.test.js`).
+
+### Before opening a pull request
+
+- Export any new functions to `src/index.ts`
+- Add a test suite for any new functions
+- Ensure tests pass (`npm t`)
+- Increment the package.json version using `npm version`
+
+## Deploying
+
+Use `npm publish` to publish the package to npm. TypeScript will be built on publish (via `npm run build`).

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

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

Number of lines in readme file

37

increased by825%

Worsened metrics

Total package byte prevSize

2018

decreased by-71.3%

Number of package files

2

decreased by-88.24%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes