diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..aff82a1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "npm" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..eacf1ea --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,41 @@ +name: "CodeQL" + +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + schedule: + - cron: "39 10 * * 3" + +jobs: + analyze: + name: Analyze + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} + permissions: + security-events: write + actions: read + contents: read + + strategy: + fail-fast: false + matrix: + language: ["javascript-typescript"] + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: "/language:${{matrix.language}}" diff --git a/.gitignore b/.gitignore index 9b1ee42..527db2f 100644 --- a/.gitignore +++ b/.gitignore @@ -173,3 +173,6 @@ dist # Finder (MacOS) folder config .DS_Store + +# Build assets +build diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..48a9433 --- /dev/null +++ b/.npmignore @@ -0,0 +1,12 @@ +.husky +.vscode +.eslintrc.cjs +.lintstagedrc +.gitignore +.prettierrc.yaml +.swcrc +commitlint.config.js +markdownlint.jsonc +tsconfig.json +bun.lockb +.github diff --git a/.swcrc b/.swcrc index cbc49b5..774a8bd 100644 --- a/.swcrc +++ b/.swcrc @@ -5,6 +5,10 @@ "target": "esnext", "parser": { "syntax": "typescript" + }, + "baseUrl": "./", + "paths": { + "@/*": ["src/*"] } } } diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..86a564a --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,5 @@ +# Authors + +- [Raul Catalinas Esteban](https://github.com/RaulCatalinas) - Main developer of the project. + +- [Thomas](https://github.com/xxxAlvaDevxxx) - Main developer of the project. diff --git a/README.md b/README.md index c8aa907..15cebc7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,43 @@ -# huskybc +# HuskyBC -To install dependencies: +HuskyBC is a command line for easy Husky configuration + +## Run Locally + +Clone the project + +```bash + git clone https://github.com/RaulCatalinas/HuskyBC.git + #or + git clone git@github.com:RaulCatalinas/HuskyBC.git + #or + gh repo clone RaulCatalinas/HuskyBC +``` + +Go to the project directory + +```bash + cd HuskyBC +``` + +Install dependencies ```bash -bun install + bun install ``` -To run: +Running the CLI ```bash -bun run index.ts + bun src/index.ts ``` -This project was created using `bun init` in bun v1.1.4. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +## Feedback + +If you have any feedback, please reach out to us at + +## Project Overview + +This project is developed by a team of passionate contributors. + +To learn more about the people behind the project, please visit the [Contributors](AUTHORS.md) page. diff --git a/tsconfig.json b/tsconfig.json index 238655f..3ef60da 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,6 +22,12 @@ // Some stricter flags (disabled by default) "noUnusedLocals": false, "noUnusedParameters": false, - "noPropertyAccessFromIndexSignature": false + "noPropertyAccessFromIndexSignature": false, + + // Import alias + "baseUrl": "./", + "paths": { + "@/*": ["src/*"] + } } }