feat: using typescript to refactor

.dockerignore

@@ -0,0 +1,123 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+.husky/
+.github/
+
+docs/
+dist/
+tools/

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.eslintignore

@@ -0,0 +1,6 @@
+dist/
+scripts/
+cmd/
+tools/
+
+*.d.ts

.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint/eslint-plugin', 'import', 'eslint-plugin-tsdoc'],
+  extends: ['plugin:@typescript-eslint/recommended'],
+  env: {
+    jest: true,
+    node: true,
+  },
+  rules: {
+    'no-console': 0,
+    '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/no-dupe-class-members': ['error'],
+    '@typescript-eslint/no-useless-constructor': ['error'],
+    '@typescript-eslint/no-inferrable-types': ['off'],
+  },
+  ignorePatterns: ['example', 'fixture']
+};

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - '[0-9]+.x'
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm install
+      - run: npm run test:coverage
+      - run: npm run test:ci
+

.gitignore

@@ -5,7 +5,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
-.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -42,8 +41,8 @@ build/Release
 node_modules/
 jspm_packages/
 
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
+# TypeScript v1 declaration files
+typings/
 
 # TypeScript cache
 *.tsbuildinfo
@@ -54,9 +53,6 @@ web_modules/
 # Optional eslint cache
 .eslintcache
 
-# Optional stylelint cache
-.stylelintcache
-
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/
@@ -72,41 +68,29 @@ web_modules/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variable files
+# dotenv environment variables file
 .env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
+.env.test
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
-.parcel-cache
 
 # Next.js build output
 .next
-out
 
 # Nuxt.js build / generate output
 .nuxt
 dist
 
 # Gatsby files
 .cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
 # https://nextjs.org/blog/next-9-1#public-directory-support
 # public
 
 # vuepress build output
 .vuepress/dist
 
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
 # Serverless directories
 .serverless/
 
@@ -119,13 +103,15 @@ dist
 # TernJS port file
 .tern-port
 
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-.DS_Store
+# Yarn
+**/.yarn/*
+!**/.yarn/releases
+!**/.yarn/plugins
+!**/.yarn/sdks
+!**/.yarn/versions
+**/.pnp.*
+
+# Project
+.idea/
+.vscode/
+tools/dev

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+[ -n "$CI" ] && exit 0
+
+npx --no-install commitlint --config commitlint.config.cjs --edit "$1"

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+[ -n "$CI" ] && exit 0
+
+npx --no-install lint-staged

.nvmrc

@@ -0,0 +1 @@
+v20.11.0

.prettierignore

@@ -0,0 +1,14 @@
+.github
+.yarn
+coverage
+build
+docs
+dist
+out
+temp
+
+*.yml
+*.html
+*.md
+*.json
+*.d.ts

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "trailingComma": "all",
+  "printWidth": 120,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "quoteProps": "as-needed",
+  "bracketSpacing": true,
+  "proseWrap": "never",
+  "endOfLine": "auto"
+}

.versionrc.json

@@ -0,0 +1,13 @@
+{
+  "types": [
+    { "type": "feat", "section": "Features" },
+    { "type": "fix", "section": "Bug Fixes" },
+    { "type": "chore", "section": "Chore", "hidden": false },
+    { "type": "docs", "section": "Docs", "hidden": false },
+    { "type": "style", "section": "Refactor", "hidden": false },
+    { "type": "refactor", "section": "Refactor", "hidden": false },
+    { "type": "perf", "section": "Perf", "hidden": false },
+    { "type": "test", "section": "Refactor", "hidden": false },
+    { "type": "build", "section": "Build", "hidden": false }
+  ]
+}

Makefile

@@ -0,0 +1,34 @@
+SHELL := /bin/bash
+
+.DEFAULT_GOAL := help
+.PHONY: help
+help:
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+up: ## Run a local development environment with Docker Compose.
+	@docker-compose -f ./deployments/dev/docker-compose.yml up --build --force-recreate
+
+recreate: ## Recreate and run development docker compose
+	@docker-compose -f ./deployments/dev/docker-compose.yml up --build --force-recreate
+
+down: ## Stop Docker Compose local development environment.
+	@docker-compose -f ./deployments/dev/docker-compose.yml down
+
+clean: ## Clean Docker Compose local development environment.
+	@docker-compose -f ./deployments/dev/docker-compose.yml down --remove-orphans --volumes
+
+.PHONY: test
+test: ## Run tests
+	@npm test
+
+fmt: ## Format code
+	@npm run format
+
+lint: ## Run static analysis
+	@npm run lint
+
+check: ## Run all checks for this project
+	@npm run format:check
+	@npm run lint
+	@npm run test
+	@npm run build

README.md

@@ -53,7 +53,7 @@ npx sdp-analyzer analyze react,vue,svelte,audio-analyser-cli
 ### API Reference
 
 ```javascript
-const sdpAnalyer = require("sdp-analyzer");
+const { analyzeNpmPackage } = require("sdp-analyzer");
 try {
   const deps = await sdpAnalyer.analyze("react");
 } catch (error) {