chore: bump deps, refactored configs

titanism · titanism · commit 7bb4b7d8f29d · 2022-06-06T15:17:26.000-05:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,26 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        node_version:
+          - 14
+          - 16
+          - 18
+    name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@
 node_modules
 coverage
 .nyc_output
-locales
+locales/
 package-lock.json
 
 
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn commitlint --edit $1
+npx --no-install commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint-staged
+npx --no-install lint-staged && npm test
diff --git a/.npmignore b/.npmignore
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  trailingComma: 'none'
+};
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['preset-github']
+};
diff --git a/.travis.yml b/.travis.yml
diff --git a/.xo-config.js b/.xo-config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  prettier: true,
+  space: true,
+  extends: ['xo-lass']
+};
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # [**@ladjs/api**](https://github.com/ladjs/api)
 
 [![build status](https://img.shields.io/travis/ladjs/api.svg)](https://travis-ci.org/ladjs/api)
-[![code coverage](https://img.shields.io/codecov/c/github/ladjs/api.svg)](https://codecov.io/gh/ladjs/api)
 [![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
@@ -26,12 +25,6 @@
 npm install @ladjs/api
 ```
 
-[yarn][]:
-
-```sh
-yarn add @ladjs/api
-```
-
 
 ## Usage
 
@@ -53,5 +46,3 @@ See <https://github.com/ladjs/lad/blob/master/template/api.js> for the most up t
 ##
 
 [npm]: https://www.npmjs.com/
-
-[yarn]: https://yarnpkg.com/
diff --git a/index.js b/index.js
@@ -30,7 +30,7 @@ const responseTime = require('response-time');
 const sharedConfig = require('@ladjs/shared-config');
 const { boolean } = require('boolean');
 
-const RATE_LIMIT_EXCEEDED = `Rate limit exceeded, retry in %s.`;
+const RATE_LIMIT_EXCEEDED = 'Rate limit exceeded, retry in %s.';
 
 class API {
   // eslint-disable-next-line complexity
@@ -41,16 +41,16 @@ class API {
       ...config
     };
 
-    // initialize the app
+    // Initialize the app
     const app = new Koa();
 
-    // only trust proxy if enabled
+    // Only trust proxy if enabled
     app.proxy = boolean(process.env.TRUST_PROXY);
 
-    // specify that this is our api (used by error handler)
+    // Specify that this is our api (used by error handler)
     app.context.api = true;
 
-    // initialize cabin
+    // Initialize cabin
     this.logger = _.isPlainObject(this.config.logger)
       ? new Cabin(this.config.logger)
       : this.config.logger instanceof Cabin
@@ -60,7 +60,7 @@ class API {
         });
     app.context.logger = this.logger;
 
-    // initialize redis
+    // Initialize redis
     this.client =
       this.config.redis === false
         ? false
@@ -69,7 +69,7 @@ class API {
         : this.config.redis;
     app.context.client = this.client;
 
-    // expose passport
+    // Expose passport
     this.passport =
       this.config.passport === false
         ? false
@@ -78,50 +78,55 @@ class API {
         : this.config.passport;
     app.context.passport = this.passport;
 
-    // listen for errors emitted by app
-    app.on('error', (err, ctx) => {
-      ctx.logger[err.status && err.status < 500 ? 'warn' : 'error'](err);
+    // Listen for errors emitted by app
+    app.on('error', (error, ctx) => {
+      ctx.logger[error.status && error.status < 500 ? 'warn' : 'error'](error);
     });
 
-    // override koa's undocumented error handler
+    // Override koa's undocumented error handler
     app.context.onerror = errorHandler(false);
 
-    // adds request received hrtime and date symbols to request object
+    // Adds request received hrtime and date symbols to request object
     // (which is used by Cabin internally to add `request.timestamp` to logs
     app.use(requestReceived);
 
-    // configure timeout
+    // Configure timeout
     if (this.config.timeout) {
       const timeout = new Timeout(this.config.timeout);
       app.use(timeout.middleware);
     }
 
-    // adds `X-Response-Time` header to responses
+    // Adds `X-Response-Time` header to responses
     app.use(koaConnect(responseTime()));
 
-    // adds or re-uses `X-Request-Id` header
+    // Adds or re-uses `X-Request-Id` header
     app.use(koaConnect(requestId()));
 
-    // use the cabin middleware (adds request-based logging and helpers)
+    // Use the cabin middleware (adds request-based logging and helpers)
     app.use(this.logger.middleware);
 
-    // allow before hooks to get setup
-    if (_.isFunction(this.config.hookBeforeSetup))
+    // Allow before hooks to get setup
+    if (_.isFunction(this.config.hookBeforeSetup)) {
       this.config.hookBeforeSetup(app);
+    }
 
-    // basic auth
-    if (this.config.auth) app.use(auth(this.config.auth));
+    // Basic auth
+    if (this.config.auth) {
+      app.use(auth(this.config.auth));
+    }
 
-    // rate limiting
+    // Rate limiting
     if (this.client && this.config.rateLimit) {
       app.use((ctx, next) => {
-        // check against ignored/whitelisted paths
+        // Check against ignored/whitelisted paths
         if (
           Array.isArray(this.config.rateLimitIgnoredGlobs) &&
           this.config.rateLimitIgnoredGlobs.length > 0
         ) {
           const match = multimatch(ctx.path, this.config.rateLimitIgnoredGlobs);
-          if (Array.isArray(match) && match.length > 0) return next();
+          if (Array.isArray(match) && match.length > 0) {
+            return next();
+          }
         }
 
         return ratelimit({
@@ -138,36 +143,40 @@ class API {
       });
     }
 
-    // remove trailing slashes
+    // Remove trailing slashes
     app.use(removeTrailingSlashes());
 
-    // i18n
+    // I18n
     if (this.config.i18n) {
       const i18n = this.config.i18n.config
         ? this.config.i18n
         : new I18N({ ...this.config.i18n, logger: this.logger });
       app.use(i18n.middleware);
     }
 
-    // conditional-get
+    // Conditional-get
     app.use(conditional());
 
-    // etag
+    // Etag
     app.use(etag());
 
-    // cors
-    if (this.config.cors) app.use(cors(this.config.cors));
+    // Cors
+    if (this.config.cors) {
+      app.use(cors(this.config.cors));
+    }
 
-    // body parser
+    // Body parser
     app.use(bodyParser());
 
-    // pretty-printed json responses
+    // Pretty-printed json responses
     app.use(json());
 
-    // passport
-    if (this.passport) app.use(this.passport.initialize());
+    // Passport
+    if (this.passport) {
+      app.use(this.passport.initialize());
+    }
 
-    // store the user's last ip address in the background
+    // Store the user's last ip address in the background
     if (this.config.storeIPAddress) {
       const storeIPAddress = new StoreIPAddress({
         logger: this.logger,
@@ -179,27 +188,30 @@ class API {
     // 404 handler
     app.use(koa404Handler);
 
-    // allow before hooks to get setup
-    if (_.isFunction(this.config.hookBeforeRoutes))
+    // Allow before hooks to get setup
+    if (_.isFunction(this.config.hookBeforeRoutes)) {
       this.config.hookBeforeRoutes(app);
+    }
 
-    // mount the app's defined and nested routes
+    // Mount the app's defined and nested routes
     if (this.config.routes) {
-      if (_.isFunction(this.config.routes.routes))
+      if (_.isFunction(this.config.routes.routes)) {
         app.use(this.config.routes.routes());
-      else app.use(this.config.routes);
+      } else {
+        app.use(this.config.routes);
+      }
     }
 
-    // start server on either http or https
+    // Start server on either http or https
     this.server =
       this.config.protocol === 'https'
         ? https.createServer(this.config.ssl, app.callback())
         : http.createServer(app.callback());
 
-    // expose the app
+    // Expose the app
     this.app = app;
 
-    // bind listen/close to this
+    // Bind listen/close to this
     this.listen = this.listen.bind(this);
     this.close = this.close.bind(this);
   }
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-conventional']`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ plugins: ['preset-github']`
	`3`	`+};`