@smg-automotive/example - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1-test-semantic-release-28a9726de47939ef418ac579cb5f67f3ab808c06.1

package.json

 {
   "name": "@smg-automotive/example",
-  "version": "1.0.0",
+  "version": "1.0.1-test-semantic-release-28a9726de47939ef418ac579cb5f67f3ab808c06.1",
   "description": "A boilerplate package setup",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
   "files": [
@@ -30,33 +31,22 @@ "dist/**/*"
   "devDependencies": {
-    "@rollup/plugin-commonjs": "22.0.0",
-    "@rollup/plugin-node-resolve": "13.2.1",
-    "@rollup/plugin-typescript": "8.3.2",
-    "@testing-library/jest-dom": "5.16.4",
-    "@testing-library/react": "13.1.1",
-    "@testing-library/user-event": "14.1.1",
-    "@types/jest": "27.4.1",
-    "@typescript-eslint/eslint-plugin": "5.21.0",
-    "@typescript-eslint/parser": "5.21.0",
-    "eslint": "8.14.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jest": "26.1.5",
-    "eslint-plugin-jsx-a11y": "6.5.1",
-    "eslint-plugin-prettier": "4.0.0",
-    "eslint-plugin-react": "7.29.4",
-    "eslint-plugin-react-hooks": "4.5.0",
-    "eslint-plugin-testing-library": "5.3.1",
-    "jest": "28.0.3",
-    "jest-environment-jsdom": "28.0.2",
-    "prettier": "2.6.2",
-    "rimraf": "3.0.2",
-    "rollup": "2.70.2",
-    "rollup-plugin-dts": "4.2.1",
+    "@rollup/plugin-commonjs": "25.0.7",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-typescript": "11.1.5",
+    "@smg-automotive/eslint-config": "4.0.34",
+    "@testing-library/jest-dom": "6.2.0",
+    "@testing-library/react": "14.1.2",
+    "@testing-library/user-event": "14.5.2",
+    "@types/jest": "29.5.11",
+    "@types/node": "20.10.7",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "rimraf": "5.0.5",
+    "rollup": "4.9.4",
+    "rollup-plugin-dts": "6.1.0",
     "rollup-plugin-peer-deps-external": "2.2.4",
-    "semantic-release": "19.0.2",
-    "ts-jest": "28.0.0-next.2",
-    "ts-node": "10.7.0",
-    "typescript": "4.6.4"
+    "semantic-release": "22.0.12",
+    "ts-jest": "29.1.1",
+    "ts-node": "10.9.2",
+    "typescript": "5.3.3"
   }
 }

README.md

@@ -1,2 +0,4 @@
-To use this template create a new repository and select `example-pkg` from the template dropdown. Make sure to name your repository following `<name>-pkg` convention.
+To use this template create a new repository and select `example-pkg` from the template dropdown. 
+Make sure to name your repository following `<name>-pkg` convention.
+If you're interested in automated dependency updates make sure that `renovate` has access to the new repository.
 
@@ -7,4 +9,12 @@ # Things to do change when you use this repository as a template:
 - [ ] update `repository` and `homepage` sections in `package.json` to point to your GitHub repository
-- [ ] ensure that Frontend team has the admin access to the repository
-- [ ] ensure that the Bots team has write access to the repository (this is needed to release the package)
+- [ ] ensure that branch protection rules are applied to the `main` branch (Settings > Branches)
+  - Require a pull request before merging
+  - Require approvals
+  - Require status checks to pass before merging (project needs to be built in circle for the checks to show up)
+  - Require linear history
+  - Include administrators
+- [ ] enable `dependabot` for security updates (Settings > Code security and analysis)
+- [ ] ensure that Frontend team has the admin access to the repository (Settings > Collaborators and teams)
+- [ ] invite `automotiveengineeringbot` as an outside collaborator to the repository with write access (this is needed to release the package)
+- [ ] login to GitHub as `automotiveengineeringbot` and accept the invitation (credentials are in 1password)
 - [ ] provide usage examples in the `README.md`
@@ -42,2 +52,2 @@ - [ ] enable the project on circleci.com to build and test your package
 New versions are released on the ci using semantic-release as soon as you merge into master. Please
-make sure your merge commit message adheres to the corresponding conventions.
+make sure your merge commit message adheres to the corresponding [conventions](https://www.conventionalcommits.org/en/v1.0.0/) and your branch name does not contain forward slashes `/`.

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6318

increased by8.39%

Dev dependency count

19

decreased by-36.67%

Number of lines in readme file

52

increased by23.81%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes