@apolitical/eslint-config 0.0.1-rc.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2022-01-20
+### Fixed
+- Pipeline node version
+
+## [1.0.0] - 2022-01-17
+### Changed
+- Updated Dependencies
+- Upgraded Node.js version
+- Revamped GitLab pipelines
+
+## [0.0.1] - 2021-06-29
+### Added
+- Initial setup

package/README.md

@@ -1,3 +1,32 @@
 # Apolitical Eslint Config
 
-A node module for our code style
+Apolitical ESLint configuration for Node.js projects (backend)
+
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 16.13.2+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
+## Installation
+
+Install with `yarn`:
+
+```sh
+yarn add -D @apolitical/eslint-config
+```
+
+## Usage
+
+Link the ESLint configurations from your `package.json`:
+
+```json
+  "eslintConfig": {
+    "extends": "@apolitical/eslint-config/base.config"
+  },
+  "prettier": "@apolitical/eslint-config/prettier.config",
+```

package/base.config.js

@@ -1,4 +1,6 @@
-{
+"use strict";
+
+module.exports = {
   "extends": [
     "eslint:recommended",
     "plugin:prettier/recommended",
@@ -13,4 +15,4 @@
     "ecmaVersion": 2018
   },
   "plugins": ["jest"]
-}
+};

package/package.json

@@ -1,47 +1,41 @@
 {
   "name": "@apolitical/eslint-config",
-  "version": "0.0.1-rc.0",
-  "description": "Apolitical ESlint confige module",
+  "version": "1.0.1",
+  "description": "Apolitical ESLint configuration for Node.js projects (backend)",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>"
-  ],
   "license": "MIT",
   "main": "base.config.js",
   "files": [
     "base.config.js",
     "prettier.config.js"
   ],
+  "scripts": {
+    "test": "exit 0",
+    "integration-test": "exit 0",
+    "unit-test": "exit 0",
+    "lint": "exit 0",
+    "format": "exit 0"
+  },
   "keywords": [
     "ESLint",
     "Prettier",
     "Node Modules"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git@gitlab.com:apolitical/node-modules/apolitical-eslint-config.git"
-  },
   "dependencies": {
-    "eslint": "7.25.0",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-prettier": "3.4.0",
-    "prettier": "2.2.1"
+    "eslint-plugin-jest": "25.7.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "prettier": "2.5.1"
   },
   "peerDependencies": {
-    "eslint": "7.25.0",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-prettier": "3.4.0",
-    "prettier": "2.2.1"
- },
- "engines": {
-  "node": ">=12.20.1"
- }
-}
+    "eslint-plugin-jest": "25.7.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "prettier": "2.5.1"
+  },
+  "engines": {
+    "node": ">=16.13.2"
+  }
+}

package/prettier.config.js

@@ -1,7 +1,9 @@
-{
+'use strict';
+
+module.exports = {
   "useTabs": false,
   "printWidth": 120,
   "tabWidth": 2,
   "singleQuote": true,
   "trailingComma": "all"
-}
+};