Setup codechecks

.circleci/config.yml

@@ -7,12 +7,12 @@ jobs:
       - checkout
 
       - restore_cache:
-          key: dependency-cache-{{ checksum "package-lock.json" }}
+          key: dependency-cache-{{ checksum "yarn.lock" }}
 
-      - run: npm install
+      - run: yarn
 
       - save_cache:
-          key: dependency-cache-{{ checksum "package-lock.json" }}
+          key: dependency-cache-{{ checksum "yarn.lock" }}
           paths:
             - ./node_modules
 
@@ -24,6 +24,26 @@ jobs:
           name: Format check
           command: npm run format:check
 
+      # - run:
+      #     name: Run tests
+      #     command: npm run test
+
+      - run:
+          name: Setup Chrome
+          command: |
+            wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add - \
+            && sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+            && sudo apt-get update \
+            && sudo apt-get install -y google-chrome-unstable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst ttf-freefont \
+              --no-install-recommends \
+            && sudo rm -rf /var/lib/apt/lists/*
+
+      - run:
+          name: Setup GraphViz
+          command: |
+            sudo apt-get update \
+            && sudo apt-get install -y graphviz
+
       - run:
-          name: Run tests
-          command: npm run test
+          name: Run codechecks
+          command: DEBUG=codechecks:* npx codechecks

.dependency-cruiser.js

@@ -0,0 +1,257 @@
+module.exports = {
+    forbidden: [
+        /* rules from the 'recommended' preset: */
+        {
+            name: 'no-circular',
+            severity: 'warn',
+            comment:
+                'This dependency is part of a circular relationship. You might want to revise ' +
+                'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',
+            from: {},
+            to: {
+                circular: true
+            }
+        },
+        {
+            name: 'no-orphans',
+            severity: 'error',
+            comment:
+                "This is an orphan module - it's likely not used (anymore?). Either use it or remove it. If it's " +
+                "logical this module is an orphan (i.e. it's a config file), add an exception for it in your " +
+                "dependency-cruiser configuration.",
+            from: {
+                orphan: true,
+                pathNot: '\\.d\\.ts$'
+            },
+            to: {}
+        },
+        {
+            name: 'no-deprecated-core',
+            comment:
+                'A module depends on a node core module that has been deprecated. Find an alternative - these are ' +
+                "bound to exist - node doesn't deprecate lightly.",
+            severity: 'warn',
+            from: {},
+            to: {
+                dependencyTypes: [
+                  'core'
+                ],
+                path: '^(punycode|domain|constants|sys|_linklist|_stream_wrap)$'
+            }
+        },
+        {
+            name: 'not-to-deprecated',
+            comment:
+                'This module uses a (version of an) npm module that has been deprecated. Either upgrade to a later ' +
+                'version of that module, or find an alternative. Deprecated modules are a security risk.',
+            severity: 'warn',
+            from: {},
+            to: {
+                dependencyTypes: [
+                  'deprecated'
+                ]
+            }
+        },
+        {
+            name: 'no-non-package-json',
+            severity: 'error',
+            comment:
+                "This module depends on an npm package that isn't in the 'dependencies' section of your package.json. " +
+                "That's problematic as the package either (1) won't be available on live (2 - worse) will be " +
+                "available on live with an non-guaranteed version. Fix it by adding the package to the dependencies " +
+                "in your package.json.",
+            from: {},
+            to: {
+                dependencyTypes: [
+                  'npm-no-pkg',
+                  'npm-unknown'
+                ]
+            }
+        },
+        {
+            name: 'not-to-unresolvable',
+            comment:
+                "This module depends on a module that cannot be found ('resolved to disk'). If it's an npm " +
+                'module: add it to your package.json. In all other cases you likely already know what to do.',
+            severity: 'error',
+            from: {},
+            to: {
+                couldNotResolve: true
+            }
+        },
+        {
+            name: 'no-duplicate-dep-types',
+            comment:
+                "Likley this module depends on an external ('npm') package that occurs more than once " +
+                "in your package.json i.e. bot as a devDependencies and in dependencies. This will cause " +
+                "maintenance problems later on.",
+            severity: 'warn',
+            from: {},
+            to: {
+                moreThanOneDependencyType: true
+            }
+        },
+
+        /* rules you might want to tweak for your specific situation: */
+        {
+            name: 'not-to-test',
+            comment:
+                "This module depends on code within a folder that should only contain tests. As tests don't " +
+                "implement functionality this is odd. Either you're writing a test outside the test folder " +
+                "or there's something in the test folder that isn't a test.",
+            severity: 'error',
+            from: {
+                pathNot: '^(test|spec)'
+            },
+            to: {
+                path: '^(test|spec)'
+            }
+        },
+        {
+            name: 'not-to-spec',
+            comment:
+                'This module depends on a spec (test) file. The sole responsibility of a spec file is to test code. ' +
+                "If there's something in a spec that's of use to other modules, it doesn't have that single " +
+                'responsibility anymore. Factor it out into (e.g.) a separate utility/ helper or a mock.',
+            severity: 'error',
+            from: {},
+            to: {
+                path: '\\.spec\\.(js|ts|ls|coffee|litcoffee|coffee\\.md)$'
+            }
+        },
+        {
+            name: 'not-to-dev-dep',
+            severity: 'error',
+            comment:
+                "This module depends on an npm package from the 'devDependencies' section of your " +
+                'package.json. It looks like something that ships to production, though. To prevent problems ' +
+                "with npm packages that aren't there on production declare it (only!) in the 'dependencies'" +
+                'section of your package.json. If this module is development only - add it to the ' +
+                'from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration',
+            from: {
+                path: '^(src|app|lib)',
+                pathNot: '\\.spec\\.(js|ts|ls|coffee|litcoffee|coffee\\.md)$'
+            },
+            to: {
+                dependencyTypes: [
+                    'npm-dev'
+                ]
+            }
+        },
+        {
+            name: 'optional-deps-used',
+            severity: 'info',
+            comment:
+                "This module depends on an npm package that is declared as an optional dependency " +
+                "in your package.json. As this makes sense in limited situations only, it's flagged here. " +
+                "If you're using an optional dependency here by design - add an exception to your" +
+                "depdency-cruiser configuration.",
+            from: {},
+            to: {
+                dependencyTypes: [
+                    'npm-optional'
+                ]
+            }
+        },
+        {
+            name: 'peer-deps-used',
+            comment:
+                "This module depends on an npm package that is declared as a peer dependency " +
+                "in your package.json. This makes sense if your package is e.g. a plugin, but in " +
+                "other cases - maybe not so much. If the use of a peer dependency is intentional " +
+                "add an exception to your dependency-cruiser configuration.",
+            severity: 'warn',
+            from: {},
+            to: {
+                dependencyTypes: [
+                    'npm-peer'
+                ]
+            }
+        }
+    ],
+    options: {
+
+        /* conditions specifying which files not to follow further when encountered:
+           - path: a regular expression to match
+           - dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/develop/doc/rules-reference.md#dependencytypes
+             for a complete list
+        */
+        doNotFollow: {
+            // path: 'node_modules',
+            dependencyTypes: [
+                'npm',
+                'npm-dev',
+                'npm-optional',
+                'npm-peer',
+                'npm-bundled',
+                'npm-no-pkg'
+            ]
+        }
+
+        /* conditions specifying which dependencies to exclude
+           - path: a regular expression to match
+           - dynamic: a boolean indicating whether to ignore dynamic (true) or static (false) dependencies.
+                    leave out if you want to exclude neither (recommended!)
+        */
+        // , exclude : {
+        //   path: ''
+        //   , dynamic: true
+        // }
+
+        /* pattern specifying which files to include (regular expression)
+           dependency-cruiser will skip everything not matching this pattern
+        */
+        // , includeOnly : ''
+
+        /* list of module systems to cruise */
+        // , moduleSystems: ['amd', 'cjs', 'es6', 'tsd']
+
+        /* prefix for links in html and svg output (e.g. https://github.com/you/yourrepo/blob/develop/) */
+        // , prefix: ''
+
+        /* if true detect dependencies that only exist before typescript-to-javascript compilation */
+        // , tsPreCompilationDeps: false
+
+        /* if true combines the package.jsons found from the module up to the base
+           folder the cruise is initiated from. Useful for how (some) mono-repos
+           manage dependencies & dependency definitions.
+         */
+        // , combinedDependencies: false
+
+        /* if true leave symlinks untouched, otherwise use the realpath */
+        // , preserveSymlinks: false
+
+        /* Typescript project file ('tsconfig.json') to use for
+           (1) compilation and
+           (2) resolution (e.g. with the paths property)
+
+           The (optional) fileName attribute specifies which file to take (relative to
+           dependency-cruiser's current working directory). When not provided
+           defaults to './tsconfig.json'.
+         */
+        // , tsConfig: {
+        //    fileName: './tsconfig.json'
+        // }
+
+        /* Webpack configuration to use to get resolve options from.
+
+          The (optional) fileName attribute specifies which file to take (relative to dependency-cruiser's
+          current working directory. When not provided defaults to './webpack.conf.js'.
+
+          The (optional) `env` and `args` attributes contain the parameters to be passed if
+          your webpack config is a function and takes them (see webpack documentation
+          for details)
+         */
+        // , webpackConfig: {
+        //    fileName: './webpack.conf.js'
+        //    , env: {}
+        //    , args: {}
+        // }
+
+        /* How to resolve external modules - use "yarn-pnp" if you're using yarn's Plug'n'Play.
+           otherwise leave it out (or set to the default, which is 'node_modules')
+        */
+        // , externalModuleResolutionStrategy: 'node_modules'
+    }
+};
+// generated: [email protected] on 2019-09-17T23:14:55.503Z

codechecks.yml

@@ -0,0 +1,22 @@
+checks:
+  - name: codechecks-git-no-uncommitted
+
+  - name: codechecks-dependency-cruiser
+    options:
+      exclude: (node_modules)
+      config: .dependency-cruiser.js
+      graph: true
+      paths:
+        - src
+
+  # - name: build-size-watcher
+  #   options:
+  #     gzip: false
+  #     files:
+  #       - path: "./build/*.js"
+  #         # maxSize: 800KB
+  #       - path: "./build/*.html"
+
+  # - name: lighthouse-keeper
+  #   options:
+  #     buildPath: ./build