first commit for template; config files and such

This commit is contained in:
James Brumond 2023-06-18 17:55:10 -07:00
commit 9dc544d4a3
Signed by: james
GPG Key ID: E8F2FC44BAA3357A
6 changed files with 91 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

37
package-lock.json generated Normal file
View File

@ -0,0 +1,37 @@
{
"name": "@templates/typescript-types",
"version": "1.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@templates/typescript-types",
"version": "1.0.0",
"license": "ISC",
"devDependencies": {
"typescript": "^5.1.3"
}
},
"node_modules/typescript": {
"version": "5.1.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.3.tgz",
"integrity": "sha512-XH627E9vkeqhlZFQuL+UsyAXEnibT0kWR2FWONlr4sTjvxyJYnyefgrkyECLzM5NenmKzRAy2rR/OlYLA1HkZw==",
"dev": true,
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
},
"engines": {
"node": ">=14.17"
}
}
},
"dependencies": {
"typescript": {
"version": "5.1.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.1.3.tgz",
"integrity": "sha512-XH627E9vkeqhlZFQuL+UsyAXEnibT0kWR2FWONlr4sTjvxyJYnyefgrkyECLzM5NenmKzRAy2rR/OlYLA1HkZw==",
"dev": true
}
}
}

16
package.json Normal file
View File

@ -0,0 +1,16 @@
{
"name": "@templates/typescript-types",
"version": "1.0.0",
"description": "Template project for creating new TypeScript type-definition-only packages",
"main": "src/index.d.ts",
"types": "src/index.d.ts",
"repository": {
"type": "git",
"url": "git@git.jbrumond.me:templates/typescript-types.git"
},
"author": "James Brumond <https://jbrumond.me>",
"license": "ISC",
"devDependencies": {
"typescript": "^5.1.3"
}
}

27
readme.md Normal file
View File

@ -0,0 +1,27 @@
Template project for creating new TypeScript type-definition-only packages
---
## Get Started
### Pull down the code
```bash
git init
git pull https://gitea.jbrumond.me/templates/typescript-types.git master
```
### Update configuration
- In `package.json`, update any fields like `name`, `description`, `repository`, etc.
## Building
No build step is necessary, as the types are written directly as `.d.ts` files to begin with.

2
src/index.d.ts vendored Normal file
View File

@ -0,0 +1,2 @@
export function hello() : string;

8
tsconfig.json Normal file
View File

@ -0,0 +1,8 @@
{
"include": [
"src/**/*.d.ts"
],
"compilerOptions": {
//
}
}