feat: migrate from github

This commit is contained in:
Naomi Carrigan 2024-05-11 23:34:03 -07:00
commit 37d931de11
No known key found for this signature in database
GPG Key ID: 7019A402E94A9808
13 changed files with 164 additions and 0 deletions

8
.gitattributes vendored Normal file
View File

@ -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

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
/node_modules/
/prod/

3
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,3 @@
# Code of Conduct
Our Code of Conduct can be found here: https://docs.nhcarrigan.com/#/coc

3
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,3 @@
# Contributing
Our contributing guidelines can be found here: https://docs.nhcarrigan.com/#/contributing

5
LICENSE.md Normal file
View File

@ -0,0 +1,5 @@
# License
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
Copyright held by Naomi Carrigan.

3
PRIVACY.md Normal file
View File

@ -0,0 +1,3 @@
# Privacy Policy
Our privacy policy can be found here: https://docs.nhcarrigan.com/#/privacy

63
README.md Normal file
View File

@ -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`.

3
SECURITY.md Normal file
View File

@ -0,0 +1,3 @@
# Security Policy
Our security policy can be found here: https://docs.nhcarrigan.com/#/security

3
TERMS.md Normal file
View File

@ -0,0 +1,3 @@
# Terms of Service
Our Terms of Service can be found here: https://docs.nhcarrigan.com/#/terms

29
package.json Normal file
View File

@ -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"
}
}

18
pnpm-lock.yaml generated Normal file
View File

@ -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

3
src/index.ts Normal file
View File

@ -0,0 +1,3 @@
(async () => {
console.log("just testing!");
})();

21
tsconfig.json Normal file
View File

@ -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"]
}