Cleanup

Author: tkrotoff

.eslintignore

@@ -1,4 +1,4 @@
-# See https://github.com/eslint/eslint/issues/10341#issuecomment-440450160
+# https://github.com/eslint/eslint/issues/10341#issuecomment-440450160
 !.*
 
 .git/

.eslintrc.js

@@ -1,6 +1,7 @@
 // @ts-check
 
-module.exports = {
+/** @type {import('eslint').Linter.Config} */
+const config = {
   parser: '@typescript-eslint/parser',
   extends: [
     // /!\ Order matters
@@ -39,7 +40,7 @@ module.exports = {
     'lines-between-class-members': 'off',
     'no-useless-constructor': 'off',
 
-    // See [no-return-assign should be configurable to ignore arrow-functions](https://github.com/eslint/eslint/issues/9471)
+    // [no-return-assign should be configurable to ignore arrow-functions](https://github.com/eslint/eslint/issues/9471)
     'no-return-assign': 'off',
 
     'import/no-extraneous-dependencies': 'off',
@@ -71,3 +72,5 @@ module.exports = {
     'react-hooks/exhaustive-deps': 'error'
   }
 };
+
+module.exports = config;

.github/workflows/node.js.yml

@@ -1,6 +1,9 @@
+# https://github.com/actions/starter-workflows/blob/c934669ce246e6d64e54006b714b04199cbe445b/ci/node.js.yml
+
 name: Node.js CI
 
-on: [push]
+# https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#on
+on: [push, pull_request]
 
 jobs:
   build:

.github/workflows/npm-publish.yml

@@ -1,3 +1,5 @@
+# https://github.com/actions/starter-workflows/blob/c934669ce246e6d64e54006b714b04199cbe445b/ci/npm-publish.yml
+
 name: Node.js Package
 
 on:

.stylelintrc.js

@@ -1,9 +1,11 @@
 // @ts-check
 
-module.exports = {
+/** @type {Partial<import('stylelint').Configuration>} */
+const config = {
   extends: [
-    // As of 2019/04/08, stylelint-config-airbnb is still at v0.0.0 and has not seen a release for a year
-    // Should we keep this? Is this future proof?
+    // As of 2020/03/18, stylelint-config-airbnb is still at v0.0.0
+    // Is this future proof?
+    // https://github.com/airbnb/css/pull/56
     'stylelint-config-airbnb',
 
     'stylelint-config-recommended-scss'
@@ -20,3 +22,5 @@ module.exports = {
     'order/order': null
   }
 };
+
+module.exports = config;

examples/Bootstrap4.tsx

@@ -191,7 +191,7 @@ function Beatles() {
   );
 }
 
-// See https://en.wikipedia.org/wiki/The_Velvet_Underground#Timeline
+// https://en.wikipedia.org/wiki/The_Velvet_Underground#Timeline
 const velvetUnderground: Person[] = [
   {
     id: '0',

examples/Boxes.scss

@@ -3,7 +3,7 @@
 
 .flex-fill {
   //flex: 1 1 auto;
-  // See [flex-grow vs flex](https://github.com/angular/material/issues/2632)
+  // [flex-grow vs flex](https://github.com/angular/material/issues/2632)
   flex: auto;
 }
 

examples/jest-e2e.setup.ts

@@ -7,8 +7,8 @@ import 'regenerator-runtime/runtime';
 
 import { toMatchImageSnapshot } from 'jest-image-snapshot';
 
-// See [Event: 'unhandledRejection'](https://nodejs.org/api/process.html#process_event_unhandledrejection)
-// See [Bluebird Error management configuration](http://bluebirdjs.com/docs/api/error-management-configuration.html)
+// [Event: 'unhandledRejection'](https://nodejs.org/api/process.html#process_event_unhandledrejection)
+// [Bluebird Error management configuration](http://bluebirdjs.com/docs/api/error-management-configuration.html)
 process.on('unhandledRejection', (reason: Error | any, _promise: Promise<any>) => {
   throw reason;
 });

examples/webpack.config.js

@@ -12,7 +12,7 @@ const postcssPresetEnv = require('postcss-preset-env');
  * @param {any} _argv
  */
 module.exports = (_webpackEnv, _argv) => {
-  // See https://github.com/webpack/webpack/issues/6460#issuecomment-364286147
+  // https://github.com/webpack/webpack/issues/6460#issuecomment-364286147
 
   /** @type import('webpack').Configuration */
   const config = {
@@ -41,7 +41,7 @@ module.exports = (_webpackEnv, _argv) => {
         {
           test: /\.(js|tsx?)$/,
 
-          // See [Babel should not transpile core-js](https://github.com/zloirock/core-js/issues/514#issuecomment-476533317)
+          // [Babel should not transpile core-js](https://github.com/zloirock/core-js/issues/514#issuecomment-476533317)
           exclude: /\/core-js/,
 
           loader: 'babel-loader'

jest.config.js

@@ -18,8 +18,8 @@ const config = {
   coveragePathIgnorePatterns: [...defaults.coveragePathIgnorePatterns, './jest.setup.ts'],
 
   // By default Jest allows for __tests__/*.js, *.spec.js and *.test.js
-  // See https://jestjs.io/docs/en/configuration#testregex-string-array-string
-  // let's be strict and use *.test.js only
+  // https://jestjs.io/docs/en/configuration#testregex-string-array-string
+  // Let's be strict and use *.test.js only
   testRegex: '\\.test\\.tsx?$'
 };