tests: enforce example when using regex, add dependabot, renovate, te…

…sts all npm packages

TODO.todo

@@ -15,7 +15,7 @@ NodeJs:
   ✔ docsearch @done(23-04-27 14:38)
   - Slack
   - Github API (octokit)
-  - Storybook
+  ✔ Storybook @done(23-04-28 18:10)
   - Webpack
   - Rollup
   - Esbuild
@@ -44,13 +44,13 @@ Global:
 ✔ Detect Vercel @done(23-04-27 11:02)
 - Detect github pages
 - Detect Cloudflare
-- Detect Netlify
+✔ Detect Netlify @done(23-04-28 17:13)
 - Detect Zeit
-- Detect Fly.io
+✔ Detect Fly.io @done(23-04-28 17:13)
 - Detect Heroku
 - Detect Render
 - Detect Dependabot
-- Detect Renovate
+✔ Detect Renovate @done(23-04-28 17:20)
 ✔ Circleci @done(23-04-27 11:02)
 ✔ Travisci @done(23-04-27 11:04)
 - Codecov

src/common/techs.ts

@@ -21,6 +21,7 @@ export const list: TechItem[] = [
   { key: 'cypressci', name: 'CypressCI', type: 'ci' },
   { key: 'dart', name: 'Dart', type: 'language' },
   { key: 'datadog', name: 'Datadog', type: 'sass' },
+  { key: 'dependabot', name: 'Dependabot', type: 'ci' },
   { key: 'digitalocean', name: 'Digital Ocean', type: 'hosting' },
   { key: 'docker', name: 'Docker', type: 'tool' },
   { key: 'elasticloud', name: 'Elastic Cloud', type: 'sass' },
@@ -74,6 +75,7 @@ export const list: TechItem[] = [
   { key: 'rabbitmq', name: 'RabbitMQ', type: 'messaging' },
   { key: 'react', name: 'React', type: 'language' },
   { key: 'redis', name: 'Redis', type: 'db' },
+  { key: 'renovate', name: 'Renovate', type: 'ci' },
   { key: 'relativeci', name: 'RelativeCI', type: 'ci' },
   { key: 'ruby', name: 'Ruby', type: 'language' },
   { key: 'rust', name: 'Rust', type: 'language' },
@@ -84,7 +86,8 @@ export const list: TechItem[] = [
   { key: 'slack', name: 'Slack', type: 'sass' },
   { key: 'socketio', name: 'Socket.io', type: 'tool' },
   { key: 'sqreen', name: 'Sqreen', type: 'sass' },
-  { key: 'stylelint', name: 'Styelint', type: 'tool' },
+  { key: 'storybook', name: 'Storybook', type: 'tool' },
+  { key: 'stylelint', name: 'Stylelint', type: 'tool' },
   { key: 'swift', name: 'Swift', type: 'language' },
   { key: 'tailwind', name: 'Tailwind', type: 'tool' },
   { key: 'terraform', name: 'Terraform', type: 'tool' },

src/rules.ts

@@ -2,6 +2,7 @@ import { matchFiles, matchFilesRegex } from './common/rules/matchFiles';
 import type {
   ComponentMatcher,
   Rule,
+  RuleDependency,
   SupportedDeps,
   TechMatcher,
 } from './types/rule';
@@ -21,6 +22,9 @@ export const dependencies: Record<
   docker: [],
 };
 
+export const rawList: Array<{ ref: RuleDependency } & { type: 'dependency' }> =
+  [];
+
 export function register(rule: Rule) {
   if (registeredTech.has(rule.tech)) {
     throw new Error(`Already registered ${rule.tech}`);
@@ -35,18 +39,19 @@ export function register(rule: Rule) {
           typeof dep.name === 'string' ? new RegExp(`^${dep.name}$`) : dep.name,
         tech: rule.tech,
       });
+      rawList.push({ type: 'dependency', ref: dep });
     });
   }
 
-  if (rule.files) {
+  if (typeof rule.files !== 'undefined') {
     let matcher: TechMatcher;
     if (Array.isArray(rule.files)) {
       matcher = (files) => {
         return matchFiles(
           rule.tech,
           files,
           rule.files as string[],
-          rule.matchFullPath
+          'matchFullPath' in rule ? rule.matchFullPath : false
         );
       };
     } else {
@@ -55,7 +60,7 @@ export function register(rule: Rule) {
           rule.tech,
           files,
           rule.files as RegExp,
-          rule.matchFullPath
+          'matchFullPath' in rule ? rule.matchFullPath : false
         );
       };
     }

src/rules/app/caddy.ts

@@ -2,6 +2,7 @@ import { register } from '../../rules';
 
 register({
   tech: 'caddy',
-  files: /\.Caddyfile/,
-  dependencies: [{ type: 'docker', name: /caddy/ }],
+  files: /\.Caddyfile$/,
+  example: 'test.Caddyfile',
+  dependencies: [{ type: 'docker', name: /caddy/, example: 'caddy:0.0.0' }],
 });

src/rules/app/httpd.ts

@@ -3,5 +3,5 @@ import { register } from '../../rules';
 register({
   tech: 'httpd',
   files: ['httpd.conf'],
-  dependencies: [{ type: 'docker', name: /httpd/ }],
+  dependencies: [{ type: 'docker', name: /httpd/, example: 'httpd:0.0.0' }],
 });

src/rules/app/kibana.ts

@@ -2,5 +2,5 @@ import { register } from '../../rules';
 
 register({
   tech: 'kibana',
-  dependencies: [{ type: 'docker', name: /kibana/ }],
+  dependencies: [{ type: 'docker', name: /kibana/, example: 'kibana:0.0.0' }],
 });

src/rules/app/nginx.ts

@@ -3,5 +3,5 @@ import { register } from '../../rules';
 register({
   tech: 'nginx',
   files: ['nginx.conf'],
-  dependencies: [{ type: 'docker', name: /nginx/ }],
+  dependencies: [{ type: 'docker', name: /nginx/, example: 'nginx:0.0.0' }],
 });

src/rules/app/zookeeper.ts

@@ -2,5 +2,7 @@ import { register } from '../../rules';
 
 register({
   tech: 'zookeeper',
-  dependencies: [{ type: 'docker', name: /zookeeper/ }],
+  dependencies: [
+    { type: 'docker', name: /zookeeper/, example: 'zookeeper:0.0.0' },
+  ],
 });

src/rules/ci/codesandboxci.ts

@@ -4,4 +4,5 @@ register({
   tech: 'codesandboxci',
   matchFullPath: true,
   files: /.codesandbox\/ci.json/,
+  example: '.codesandbox/ci.json',
 });

src/rules/ci/cypressci.ts

@@ -3,8 +3,9 @@ import { register } from '../../rules';
 register({
   tech: 'cypressci',
   files: /cypress.config.(js|ts|mjs|cjs)/,
+  example: 'cypress.config.js',
   dependencies: [
     { type: 'npm', name: 'cypress' },
-    { type: 'docker', name: /cypress/ },
+    { type: 'docker', name: /cypress/, example: 'cypress:0.0.0' },
   ],
 });

src/rules/ci/dependabot.ts

@@ -0,0 +1,8 @@
+import { register } from '../../rules';
+
+register({
+  tech: 'dependabot',
+  matchFullPath: true,
+  files: /.github\/dependabot.yml/,
+  example: '.github/dependabot.yml',
+});

src/rules/ci/githubactions.ts

@@ -4,4 +4,5 @@ register({
   tech: 'githubactions',
   matchFullPath: true,
   files: /.github\/workflows\/.+\.yml/,
+  example: '.github/workflows/ci.yml',
 });

src/rules/ci/index.ts

@@ -1,6 +1,8 @@
 import './browserstack';
 import './circleci';
 import './cypressci';
+import './dependabot';
 import './githubactions';
+import './renovate';
 import './relativeci';
 import './travisci';

src/rules/ci/renovate.ts

@@ -0,0 +1,7 @@
+import { register } from '../../rules';
+
+register({
+  tech: 'renovate',
+  files: ['.renovaterc.json', '.renovaterc', 'renovate.json', 'renovate.json5'],
+  dependencies: [{ type: 'npm', name: 'renovate' }],
+});

src/rules/db/cassandra.ts

@@ -2,5 +2,7 @@ import { register } from '../../rules';
 
 register({
   tech: 'cassandra',
-  dependencies: [{ type: 'docker', name: /cassandra/ }],
+  dependencies: [
+    { type: 'docker', name: /cassandra/, example: 'cassandra:0.0.0' },
+  ],
 });

src/rules/db/couchbase.ts

@@ -4,6 +4,6 @@ register({
   tech: 'couchbase',
   dependencies: [
     { type: 'npm', name: 'couchbase' },
-    { type: 'docker', name: /couchbase/ },
+    { type: 'docker', name: /couchbase/, example: 'couchbase:0.0.0' },
   ],
 });

src/rules/db/elasticsearch.ts

@@ -4,6 +4,6 @@ register({
   tech: 'elasticsearch',
   dependencies: [
     { type: 'npm', name: '@elastic/elasticsearch' },
-    { type: 'docker', name: /elasticsearch/ },
+    { type: 'docker', name: /elasticsearch/, example: 'elasticsearch:0.0.0' },
   ],
 });

src/rules/db/influxdb.ts

@@ -4,6 +4,6 @@ register({
   tech: 'influxdb',
   dependencies: [
     { type: 'npm', name: '@influxdata/influxdb-client' },
-    { type: 'docker', name: /influxdb/ },
+    { type: 'docker', name: /influxdb/, example: 'influxdb:0.0.0' },
   ],
 });

src/rules/db/mariadb.ts

@@ -4,6 +4,6 @@ register({
   tech: 'mariadb',
   dependencies: [
     { type: 'npm', name: 'mariadb' },
-    { type: 'docker', name: /mariadb/ },
+    { type: 'docker', name: /mariadb/, example: 'mariadb:0.0.0' },
   ],
 });

src/rules/db/memcached.ts

@@ -4,6 +4,6 @@ register({
   tech: 'memcached',
   dependencies: [
     { type: 'npm', name: 'memcached' },
-    { type: 'docker', name: /memcached/ },
+    { type: 'docker', name: /memcached/, example: 'memcached:0.0.0' },
   ],
 });

src/rules/db/mongo.ts

@@ -4,6 +4,6 @@ register({
   tech: 'mongodb',
   dependencies: [
     { type: 'npm', name: 'mongoose' },
-    { type: 'docker', name: /mongo/ },
+    { type: 'docker', name: /mongo/, example: 'mongo:0.0.0' },
   ],
 });

src/rules/db/mysql.ts

@@ -4,6 +4,6 @@ register({
   tech: 'mysql',
   dependencies: [
     { type: 'npm', name: 'mysql' },
-    { type: 'docker', name: /mysql/ },
+    { type: 'docker', name: /mysql/, example: 'mysql:0.0.0' },
   ],
 });

src/rules/db/neo4j.ts

@@ -4,6 +4,6 @@ register({
   tech: 'neo4j',
   dependencies: [
     { type: 'npm', name: 'neo4j-driver' },
-    { type: 'docker', name: /neo4j/ },
+    { type: 'docker', name: /neo4j/, example: 'neo4j:0.0.0' },
   ],
 });

src/rules/db/percona.ts

@@ -2,5 +2,5 @@ import { register } from '../../rules';
 
 register({
   tech: 'percona',
-  dependencies: [{ type: 'docker', name: /percona/ }],
+  dependencies: [{ type: 'docker', name: /percona/, example: 'percona:0.0.0' }],
 });

src/rules/db/postgres.ts

@@ -4,6 +4,6 @@ register({
   tech: 'postgresql',
   dependencies: [
     { type: 'npm', name: 'pg' },
-    { type: 'docker', name: /postgres/ },
+    { type: 'docker', name: /postgres/, example: 'postgres:0.0.0' },
   ],
 });

src/rules/db/redis.ts

@@ -4,6 +4,6 @@ register({
   tech: 'redis',
   dependencies: [
     { type: 'npm', name: 'redis' },
-    { type: 'docker', name: /redis/ },
+    { type: 'docker', name: /redis/, example: 'redis:0.0.0' },
   ],
 });

src/rules/db/vault.ts

@@ -2,5 +2,5 @@ import { register } from '../../rules';
 
 register({
   tech: 'vault',
-  dependencies: [{ type: 'docker', name: /vault/ }],
+  dependencies: [{ type: 'docker', name: /vault/, example: 'vault:0.0.0' }],
 });

src/rules/index.ts

@@ -2,7 +2,7 @@ import './ci';
 import './db';
 import './hosting';
 import './messaging';
-import './npm';
+import './js';
 import './sass';
 import './spec';
 import './tool';

src/rules/npm/index.ts → src/rules/js/index.ts

@@ -11,6 +11,7 @@ import './react';
 import './sentry';
 import './sequelize';
 import './socketio';
+import './storybook';
 import './stylelint';
 import './tailwind';
 import './typescript';

src/rules/npm/jest.ts → src/rules/js/jest.ts

@@ -3,6 +3,7 @@ import { register } from '../../rules';
 register({
   tech: 'jest',
   files: /jest.config.(js|ts|mjs|cjs|json)/,
+  example: 'jest.config.ts',
   dependencies: [
     { type: 'npm', name: 'jest' },
     { type: 'npm', name: 'babel-jest' },

src/rules/js/sentry.ts

@@ -0,0 +1,8 @@
+import { register } from '../../rules';
+
+register({
+  tech: 'sentry',
+  dependencies: [
+    { type: 'npm', name: /@sentry\//, example: '@sentry/browser' },
+  ],
+});

src/rules/npm/sequelize.ts → src/rules/js/sequelize.ts

@@ -3,5 +3,7 @@ import { register } from '../../rules';
 register({
   tech: 'sequelize',
   files: ['.sequelizerc'],
-  dependencies: [{ type: 'npm', name: /sequelize(-cli)?/ }],
+  dependencies: [
+    { type: 'npm', name: /sequelize(-cli)?/, example: 'sequelize' },
+  ],
 });

src/rules/js/storybook.ts

@@ -0,0 +1,7 @@
+import { register } from '../../rules';
+
+register({
+  tech: 'storybook',
+  files: ['.storybook'],
+  dependencies: [{ type: 'npm', name: 'storybook' }],
+});

src/rules/npm/typescript.ts → src/rules/js/typescript.ts

@@ -3,5 +3,6 @@ import { register } from '../../rules';
 register({
   tech: 'typescript',
   files: /tsconfig(.[a-zA-Z0-9_-]+)?.json/,
+  example: 'tsconfig.json',
   dependencies: [{ type: 'npm', name: 'typescript' }],
 });

src/rules/messaging/rabbitmq.ts

@@ -4,6 +4,6 @@ register({
   tech: 'rabbitmq',
   dependencies: [
     { type: 'npm', name: 'amqplib' },
-    { type: 'docker', name: /rabbitmq/ },
+    { type: 'docker', name: /rabbitmq/, example: 'rabbitmq:0.0.0' },
   ],
 });