@2toad/profanity
Advanced tools
Comparing version 2.4.2 to 2.5.0
# Contribute to the Profanity project 🤝 | ||
Thank you for wanting to contribute to the Profanity project. With your contributions we can ensure Profanity remains a leading solution for filtering profanity within JavaScript projects | ||
Thank you for wanting to contribute to the Profanity project. With your contributions we can ensure Profanity remains a leading solution for filtering profanity within JavaScript projects. | ||
@@ -15,6 +15,5 @@ ## Steps for success | ||
1. Make sure you run the following scripts in local, and that all of them pass, before submitting a PR: | ||
1. `npm run lint` | ||
2. `npm run prettier` | ||
3. `npm run build` | ||
4. `npm test` | ||
1. `npm run lint:fix` | ||
2. `npm run format` | ||
3. `npm test` | ||
2. Make sure your PR is targeting the correct branch (see Step 2.ii) | ||
@@ -46,4 +45,3 @@ 3. At the top of your PR description write: "Fixes #_n_". Where _n_ is the number of the Issue your PR is fixing (e.g., `Fixes #33`). This will tell GitHub to associate your PR with the Issue. | ||
- Fix lint errors: `npm run lint:fix` | ||
- Check formatting rules: `npm run prettier` | ||
- Fix formatting errors: `npm run prettier:fix` | ||
- Fix formatting errors: `npm run format` | ||
@@ -58,3 +56,3 @@ ## Appendix | ||
The Profanity project includes an .nvmrc file, so you can run `nvm use` to switch to the proper version of Node. | ||
The Profanity project includes an .nvmrc file, so you can run `nvm use` to switch to the required version of Node. | ||
@@ -79,3 +77,3 @@ ##### Setup | ||
Deploying to Prod consist of building and publishing the Profanity lib to NPM, and are automated through our Continuous Deployment workflow. | ||
Deployments to Prod consist of building and publishing the Profanity lib to NPM, and are automated through our Continuous Deployment workflow. | ||
@@ -82,0 +80,0 @@ #### 1. Create New Version |
{ | ||
"name": "@2toad/profanity", | ||
"version": "2.4.2", | ||
"version": "2.5.0", | ||
"description": "A JavaScript profanity filter", | ||
@@ -16,3 +16,3 @@ "homepage": "https://github.com/2Toad/Profanity", | ||
"build": "npm run clean && npx tsc", | ||
"local": "npm run build && concurrently -p \"none\" \"npx tsc --watch\" \"nodemon -q dist/index.js\"", | ||
"local": "npm run clean && nodemon src/index.ts", | ||
"pretest": "npm run build", | ||
@@ -23,6 +23,5 @@ "test": "mocha -r ts-node/register tests/**/*.spec.ts", | ||
"lint": "eslint . --cache", | ||
"lint:fix": "eslint . --cache --fix", | ||
"prettier": "prettier --check **/*.ts", | ||
"prettier:fix": "prettier --write **/*.ts", | ||
"prepublishOnly": "npm run lint && npm run prettier && npm test", | ||
"lint:fix": "eslint . --fix", | ||
"format": "prettier . --write", | ||
"prepublishOnly": "npm run lint && npm test", | ||
"prepare": "husky" | ||
@@ -56,2 +55,3 @@ }, | ||
"devDependencies": { | ||
"@eslint/js": "^9.9.1", | ||
"@types/benchmark": "^2.1.5", | ||
@@ -61,13 +61,11 @@ "@types/chai": "^4.3.19", | ||
"@types/node": "^22.5.2", | ||
"@typescript-eslint/eslint-plugin": "^8.3.0", | ||
"@typescript-eslint/parser": "^8.3.0", | ||
"@typescript-eslint/eslint-plugin": "^8.4.0", | ||
"@typescript-eslint/parser": "^8.4.0", | ||
"benchmark": "^2.1.4", | ||
"chai": "^4.5.0", | ||
"concurrently": "^8.2.2", | ||
"eslint": "^8.57.0", | ||
"eslint-config-airbnb-base": "^15.0.0", | ||
"eslint": "^9.9.1", | ||
"eslint-config-prettier": "^9.1.0", | ||
"eslint-plugin-import": "^2.29.1", | ||
"eslint-plugin-prettier": "^5.2.1", | ||
"eslint-plugin-security": "^3.0.1", | ||
"globals": "^15.9.0", | ||
"husky": "^9.1.5", | ||
@@ -80,3 +78,4 @@ "lint-staged": "^15.2.10", | ||
"ts-node": "^10.9.2", | ||
"typescript": "^5.5.4" | ||
"typescript": "^5.5.4", | ||
"typescript-eslint": "^8.4.0" | ||
}, | ||
@@ -89,7 +88,5 @@ "overrides": { | ||
"lint-staged": { | ||
"*.ts": [ | ||
"eslint --cache --fix", | ||
"prettier --write" | ||
] | ||
"*.ts": "eslint --cache --fix", | ||
"*": "prettier --write" | ||
} | ||
} |
50941
41
843