clever-frontend-utils - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

dist/index.js

@@ -1,1 +0,4 @@
-// Export your library here
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var reduxAsyncUtils = require("./reduxAsyncUtils");
+exports.reduxAsyncUtils = reduxAsyncUtils;

lib/index.ts

@@ -1,1 +0,5 @@
-// Export your library here
+import * as reduxAsyncUtils from "./reduxAsyncUtils";
+
+export {
+  reduxAsyncUtils,
+};

package.json

 {
   "name": "clever-frontend-utils",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "A set of utils for frontend projects at Clever (and potentially elsewhere!)",
@@ -18,3 +18,3 @@ "main": "dist/index.js",
     ],
-    "testRegex": "/__tests__/.+\\.ts$",
+    "testRegex": ".+_test\\.ts$",
     "transform": {
@@ -37,3 +37,6 @@ "^.+\\.ts$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
     "typescript": "^2.1.5"
+  },
+  "dependencies": {
+    "lodash": "^4.17.10"
   }
 }

README.md

 # frontend-utils
 
-A repo for shared frontend utils at Clever
+A set of utils for frontend projects at Clever (and potentially elsewhere!).
 
+Note that the npm package for this repo, `clever-frontend-utils`, is public. Keep that in mind when adding utils.
+
 ## Developing
 
-- update package.json with your library name (`@clever/<name>` if private)
+To install dependencies, use:
 
-- `npm install`
+```
+npm install
+```
 
-- Write the library in the `lib` folder
+### Building Locally
 
-- Write tests in the `__tests__` folder
+If you want to build the lib for local use, run:
 
+```
+make build
+```
+
+This will compile `lib/` to JavaScript and place the output in the `dist/` directory.
+
 ## Testing
+
+To lint and test, run:
+
 ```
@@ -20,6 +33,6 @@ make test
 
-## Building for local use
-```
-# This will compile lib/ to javascript in the dist/ folder
-make build
-```
+All files ending in `_test.ts` will be considered test files by Jest.
+
+## Deploying
+
+Merging code to master will automatically result in an npm publish. Remember to version bump in the `package.json`!

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

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

22158

increased by214.39%

Number of package files

19

increased by72.73%

Lines of code

479

increased by219.33%

Number of lines in readme file

38

increased by52%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedlodash@^4.17.10

• + Addedlodash@4.17.21(transitive)