New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
consolev - npm Package Compare versions
Comparing version 1.0.7 to 1.1.0
| { | ||
| "name": "consolev", | ||
| "version": "1.0.7", | ||
| "description": "", | ||
| "main": "lib/consolev.js", | ||
| "version": "1.1.0", | ||
| "license": "MIT", | ||
| "main": "dist/index.js", | ||
| "typings": "dist/index.d.ts", | ||
| "files": [ | ||
| "dist", | ||
| "src" | ||
| ], | ||
| "engines": { | ||
| "node": ">=10" | ||
| }, | ||
| "scripts": { | ||
| "build": "babel src -d lib", | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
| "start": "tsdx watch", | ||
| "build": "tsdx build", | ||
| "test": "tsdx test", | ||
| "lint": "tsdx lint", | ||
| "prepare": "tsdx build", | ||
| "size": "size-limit", | ||
| "analyze": "size-limit --why" | ||
| }, | ||
| "author": "", | ||
| "license": "ISC", | ||
| "peerDependencies": {}, | ||
| "husky": { | ||
| "hooks": { | ||
| "pre-commit": "tsdx lint" | ||
| } | ||
| }, | ||
| "prettier": { | ||
| "printWidth": 80, | ||
| "semi": true, | ||
| "singleQuote": true, | ||
| "trailingComma": "es5" | ||
| }, | ||
| "name": "consolev", | ||
| "author": "lomocc", | ||
| "module": "dist/consolev.esm.js", | ||
| "size-limit": [ | ||
| { | ||
| "path": "dist/consolev.cjs.production.min.js", | ||
| "limit": "10 KB" | ||
| }, | ||
| { | ||
| "path": "dist/consolev.esm.js", | ||
| "limit": "10 KB" | ||
| } | ||
| ], | ||
| "devDependencies": { | ||
| "babel-cli": "^6.26.0", | ||
| "babel-core": "^6.26.3", | ||
| "babel-preset-env": "^1.7.0", | ||
| "babel-preset-stage-0": "^6.24.1" | ||
| "@size-limit/preset-small-lib": "^4.12.0", | ||
| "husky": "^6.0.0", | ||
| "size-limit": "^4.12.0", | ||
| "tsdx": "^0.14.1", | ||
| "tslib": "^2.3.0", | ||
| "typescript": "^4.3.2" | ||
| }, | ||
| "resolutions": { | ||
| "typescript": "^4.3.2" | ||
| } | ||
| } |
103
README.md
@@ -1,6 +0,103 @@ | ||
| # consolev | ||
| # TSDX User Guide | ||
| Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it. | ||
| > This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`. | ||
| > If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript) | ||
| ## Commands | ||
| TSDX scaffolds your new library inside `/src`. | ||
| To run TSDX, use: | ||
| ```bash | ||
| npm start # or yarn start | ||
| ``` | ||
| This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`. | ||
| To do a one-off build, use `npm run build` or `yarn build`. | ||
| To run tests, use `npm test` or `yarn test`. | ||
| ## Configuration | ||
| Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. | ||
| ### Jest | ||
| Jest tests are set up to run with `npm test` or `yarn test`. | ||
| ### Bundle Analysis | ||
| [`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`. | ||
| #### Setup Files | ||
| This is the folder structure we set up for you: | ||
| ```txt | ||
| /src | ||
| index.tsx # EDIT THIS | ||
| /test | ||
| blah.test.tsx # EDIT THIS | ||
| .gitignore | ||
| package.json | ||
| README.md # EDIT THIS | ||
| tsconfig.json | ||
| ``` | ||
| ### Rollup | ||
| TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. | ||
| ### TypeScript | ||
| `tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs. | ||
| ## Continuous Integration | ||
| ### GitHub Actions | ||
| Two actions are added by default: | ||
| - `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix | ||
| - `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit) | ||
| ## Optimizations | ||
| Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations: | ||
| ```js | ||
| let version = require("../package.json").version; | ||
| consolev(version); | ||
| // ./types/index.d.ts | ||
| declare var __DEV__: boolean; | ||
| // inside your code... | ||
| if (__DEV__) { | ||
| console.log('foo'); | ||
| } | ||
| ``` | ||
| You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions. | ||
| ## Module Formats | ||
| CJS, ESModules, and UMD module formats are supported. | ||
| The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found. | ||
| ## Named Exports | ||
| Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library. | ||
| ## Including Styles | ||
| There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like. | ||
| For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader. | ||
| ## Publishing to NPM | ||
| We recommend using [np](https://github.com/sindresorhus/np). |
New alerts
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
Fixed alerts
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by71.43%
12
- Lines of code
- increased by95%
78
- Number of low maintenance alerts
- decreased by-50%
1
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by1385.71%
104
Worsened metrics
- Total package byte prevSize
- decreased by-77.04%
13940
- Dev dependency count
- increased by50%
6
- Number of low supply chain risk alerts
- increased by100%
2
No dependency changes