From 37d931de1115d06bf3dc84e614bd9154a764f907 Mon Sep 17 00:00:00 2001 From: Naomi Date: Sat, 11 May 2024 23:34:03 -0700 Subject: [PATCH] feat: migrate from github --- .gitattributes | 8 ++++++ .gitignore | 2 ++ CODE_OF_CONDUCT.md | 3 +++ CONTRIBUTING.md | 3 +++ LICENSE.md | 5 ++++ PRIVACY.md | 3 +++ README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++ SECURITY.md | 3 +++ TERMS.md | 3 +++ package.json | 29 +++++++++++++++++++++ pnpm-lock.yaml | 18 +++++++++++++ src/index.ts | 3 +++ tsconfig.json | 21 ++++++++++++++++ 13 files changed, 164 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 PRIVACY.md create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 TERMS.md create mode 100644 package.json create mode 100644 pnpm-lock.yaml create mode 100644 src/index.ts create mode 100644 tsconfig.json diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..2bffe04 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +# Auto detect text files and perform LF normalization +* text eol=LF +*.ts text +*.spec.ts text + +# Ignore binary files >:( +*.png binary +*.jpg binary \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1adc378 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/node_modules/ +/prod/ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a3bbfe2 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Our Code of Conduct can be found here: https://docs.nhcarrigan.com/#/coc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f67101e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +Our contributing guidelines can be found here: https://docs.nhcarrigan.com/#/contributing diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..5424732 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,5 @@ +# License + +This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license). + +Copyright held by Naomi Carrigan. diff --git a/PRIVACY.md b/PRIVACY.md new file mode 100644 index 0000000..96791d1 --- /dev/null +++ b/PRIVACY.md @@ -0,0 +1,3 @@ +# Privacy Policy + +Our privacy policy can be found here: https://docs.nhcarrigan.com/#/privacy diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bd29eb --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Naomi's TypeScript Config + +This package holds my TypeScript configuration for easy installation and syncing changes across projects. + +## Live Version + +This package is currently published. [View the `npm` page](https://www.npmjs.com/package/@nhcarrigan/typescript-config). + +## Installation + +To install this package, run the following command: + +```bash +npm i @nhcarrigan/typescript-config typescript +``` + +## Compatibility + +This package is compatible with TypeScript 5. + +## Usage + +To use this package, add the following to your `tsconfig.json` file: + +```json +{ + "extends": "@nhcarrigan/typescript-config" +} +``` + +By default, the root directory is `src` and the output directory is `prod`. To override these: + +```json +{ + "extends": "@nhcarrigan/typescript-config", + "compilerOptions": { + "rootDir": "code", + "outDir": "dist" + } +} +``` + +## Feedback and Bugs + +If you have feedback or a bug report, please feel free to open a GitHub issue! + +## Contributing + +If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first. + +## Code of Conduct + +Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md). + +## License + +This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license). + +Copyright held by Naomi Carrigan. + +## Contact + +We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..bb3fc2d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +Our security policy can be found here: https://docs.nhcarrigan.com/#/security diff --git a/TERMS.md b/TERMS.md new file mode 100644 index 0000000..f556156 --- /dev/null +++ b/TERMS.md @@ -0,0 +1,3 @@ +# Terms of Service + +Our Terms of Service can be found here: https://docs.nhcarrigan.com/#/terms diff --git a/package.json b/package.json new file mode 100644 index 0000000..2b54678 --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "@nhcarrigan/typescript-config", + "version": "3.0.0", + "description": "Global config for my typescript projects", + "main": "tsconfig.json", + "scripts": { + "test": "tsc --rootDir './src' --outDir './prod' && echo 'build appears valid!'" + }, + "engines": { + "node": "20", + "pnpm": "8" + }, + "repository": { + "type": "git", + "url": "git+ssh://git@github.com/naomi-lgbt/typescript-config.git" + }, + "keywords": [ + "typescript" + ], + "author": "Naomi Carrigan", + "license": "SEE LICENSE IN https://docs.nhcarrigan.com/#/license", + "bugs": { + "url": "https://github.com/naomi-lgbt/typescript-config/issues" + }, + "homepage": "https://github.com/naomi-lgbt/typescript-config#readme", + "peerDependencies": { + "typescript": "^5.0.0" + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml new file mode 100644 index 0000000..cdf23d4 --- /dev/null +++ b/pnpm-lock.yaml @@ -0,0 +1,18 @@ +lockfileVersion: '6.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +dependencies: + typescript: + specifier: ^5.0.0 + version: 5.0.2 + +packages: + + /typescript@5.0.2: + resolution: {integrity: sha512-wVORMBGO/FAs/++blGNeAVdbNKtIh1rbBL2EyQ1+J9lClJ93KiiKe8PmFIVdXhHcyv44SL9oglmfeSsndo0jRw==} + engines: {node: '>=12.20'} + hasBin: true + dev: false diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..6f38902 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,3 @@ +(async () => { + console.log("just testing!"); +})(); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..c0f0998 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "CommonJS", + "allowUnreachableCode": false, + "allowUnusedLabels": false, + "exactOptionalPropertyTypes": true, + "noFallthroughCasesInSwitch": true, + "noImplicitOverride": true, + "noImplicitReturns": true, + "noUncheckedIndexedAccess": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "resolveJsonModule": true + }, + "exclude": ["../../../test"] +}