@quartz/js-utils - npm Package Compare versions

Comparing version 1.0.3 to 1.1.0

dist/index.d.ts

 export { default as arrayFromRange } from './arrayFromRange';
 export { default as hexToRGB } from './hexToRGB';
 export { default as minifyCss } from './minifyCss';
+export { default as parseDateGMT } from './parseDateGMT';
 export { default as resizeWPImage } from './resizeWPImage';
+export { default as stylizedTimestamp } from './stylizedTimestamp';
+export { default as timeAgo } from './timeAgo';

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resizeWPImage = exports.minifyCss = exports.hexToRGB = exports.arrayFromRange = void 0;
+exports.timeAgo = exports.stylizedTimestamp = exports.resizeWPImage = exports.parseDateGMT = exports.minifyCss = exports.hexToRGB = exports.arrayFromRange = void 0;
 var arrayFromRange_1 = require("./arrayFromRange");
@@ -10,4 +10,10 @@ Object.defineProperty(exports, "arrayFromRange", { enumerable: true, get: function () { return arrayFromRange_1.default; } });
 Object.defineProperty(exports, "minifyCss", { enumerable: true, get: function () { return minifyCss_1.default; } });
+var parseDateGMT_1 = require("./parseDateGMT");
+Object.defineProperty(exports, "parseDateGMT", { enumerable: true, get: function () { return parseDateGMT_1.default; } });
 var resizeWPImage_1 = require("./resizeWPImage");
 Object.defineProperty(exports, "resizeWPImage", { enumerable: true, get: function () { return resizeWPImage_1.default; } });
+var stylizedTimestamp_1 = require("./stylizedTimestamp");
+Object.defineProperty(exports, "stylizedTimestamp", { enumerable: true, get: function () { return stylizedTimestamp_1.default; } });
+var timeAgo_1 = require("./timeAgo");
+Object.defineProperty(exports, "timeAgo", { enumerable: true, get: function () { return timeAgo_1.default; } });
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@quartz/js-utils",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "A collection of reusable JavaScript utilities for Quartz products.",
@@ -15,3 +15,3 @@ "main": "dist/index.js",
     "build": "tsc",
-    "prepublish": "npm run build"
+    "prepublishOnly": "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://www.npmjs.com/package/@quartz/js-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

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

16011

increased by101.27%

Number of package files

26

increased by52.94%

Lines of code

244

increased by89.15%

Number of lines in readme file

37

increased by825%

No dependency changes