fix: dotted path, tests, proper parser for hcl

package.json

@@ -38,11 +38,11 @@
  },
  "dependencies": {
  "@actions/core": "1.10.0",
+ "@cdktf/hcl2json": "0.17.0",
  "@octokit/plugin-retry": "^4.1.3",
  "commander": "10.0.1",
  "dotenv": "16.0.3",
  "figures": "5.0.0",
- "hcl2-parser": "1.0.3",
  "kleur": "4.1.5",
  "nanoid": "4.0.2",
  "octokit": "2.0.14",

src/provider/base.ts

@@ -12,26 +12,36 @@ export interface BaseProvider {
 
 export const IGNORED_DIVE_PATHS = [
  'node_modules',
- '.git',
- '.vscode',
  'dist',
  'build',
  'bin',
  'static',
  'public',
  'vendor',
- '.svn',
+ 'terraform.tfstate.d',
+ 'migrations',
+ 'tests',
+ '__fixtures__',
+ '__snapshots__',
+ 'tmp',
+
+ // -- Dot folder
+ '.artifacts',
+ '.azure-pipelines',
+ '.dynamodb',
+ '.fusebox',
+ '.git',
+ // needed to detect github actions
+ // '.github',
+ '.gitlab',
  '.log',
  '.npm',
  '.nuxt',
+ '.react-email',
  '.serverless',
- '.fusebox',
- '.dynamodb',
- '.vuepress',
- 'migrations',
- '.vercel',
+ '.svn',
  '.terraform',
- 'terraform.tfstate.d',
- '__fixtures__',
- '__snapshots__',
+ '.vercel',
+ '.vscode',
+ '.vuepress',
 ];

src/provider/fake.ts

@@ -24,9 +24,10 @@ export class FakeProvider implements BaseProvider {
  const files = this.paths[pathRelative].sort();
  return Promise.resolve(
  files.map((file) => {
+ const isDir = file.endsWith('/');
  return {
- name: file,
- type: file.endsWith('/') ? 'dir' : 'file',
+ name: isDir ? file.substring(0, file.length - 1) : file,
+ type: isDir ? 'dir' : 'file',
  fp: path.join(pathRelative, file),
  };
  })

src/rules/ci.test.ts

@@ -19,7 +19,7 @@ for (const item of rawList) {
  paths.push('example' in item.ref ? item.ref.example : item.ref.files[0]);
 }
 
-describe('npm', () => {
+describe('ci', () => {
  it('should match everything', async () => {
  const res = await analyser({
  provider: new FakeProvider({
@@ -44,4 +44,20 @@ describe('npm', () => {
  'travisci',
  ]);
  });
+
+ it.only('enforce that we match .github', async () => {
+ const res = await analyser({
+ provider: new FakeProvider({
+ paths: {
+ '/': ['.github/'],
+ '/.github': ['workflows/'],
+ '/.github/workflows': ['main.yml'],
+ },
+ files: {
+ '/.github/workflows/main.yml': '',
+ },
+ }),
+ });
+ expect(res.toJson('').techs).toStrictEqual(['github', 'githubactions']);
+ });
 });

src/rules/spec/nodejs/dependencies.test.ts

@@ -49,6 +49,7 @@ describe('npm', () => {
  'express',
  'fastify',
  'gcp',
+ 'github',
  'hotjar',
  'influxdb',
  'koa',

src/rules/spec/terraform/component.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 
-import * as hcl_parser from 'hcl2-parser';
+import { parse } from '@cdktf/hcl2json';
 
 import { listIndexed } from '../../../common/techs.js';
 import { Payload } from '../../../payload/index.js';
@@ -25,8 +25,9 @@ export const detectTerraformComponent: ComponentMatcher = async (
 
  let json: Record<string, any>;
  try {
- json = hcl_parser.parseToObject(content)[0];
+ json = await parse(file.fp, content);
  } catch (err) /* istanbul ignore next */ {
+ console.warn('Failed to parse HCL', err);
  return false;
  }
 

src/rules/tool/github.ts

@@ -4,6 +4,8 @@ register({
  tech: 'github',
  files: ['.github'],
  dependencies: [
+ { type: 'npm', name: 'octokit' },
+ { type: 'npm', name: /^@octokit\//, example: '@octokit/types' },
  { type: 'terraform', name: 'registry.terraform.io/integrations/github' },
  ],
 });