Initial commit

.gitea/workflows/pubilsh.yaml

@@ -0,0 +1,30 @@
+
+name: Build and publish
+
+on:
+  workflow_dispatch: { }
+  # push:
+  #   branches:
+  #   - master
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    env:
+      NPM_PUBLISH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Login to package registry
+        run: |
+          npm config set @<scope name>:registry https://gitea.jbrumond.me/api/packages/<scope name>/npm/
+          npm config set -- '//gitea.jbrumond.me/api/packages/<scope name>/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
+
+      - name: Publish package
+        run: npm publish

.gitignore

@@ -0,0 +1 @@
+node_modules

package-lock.json

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

package.json

@@ -0,0 +1,19 @@
+{
+  "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",
+  "publishConfig": {
+    "registry": "https://gitea.jbrumond.me/api/packages/templates/npm/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitea.jbrumond.me/templates/typescript-types.git"
+  },
+  "author": "James Brumond <https://jbrumond.me>",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.1.3"
+  }
+}

readme.md

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

src/index.d.ts

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

tsconfig.json

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