.gitignore

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

README.md

@@ -1,20 +1,38 @@
-# New Repository Template
+# Naomi's TypeScript Config
 
-This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository.
-
-If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose.
-
-## Readme
-
-Delete all of the above text (including this line), and uncomment the below text to use our standard readme template.
-
-<!-- # Project Name
-
-Project Description
+This package holds my TypeScript configuration for easy installation and syncing changes across projects.
 
 ## Live Version
 
-This page is currently deployed. [View the live website.]
+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",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./prod"
+  }
+}
+```
+
+You may set `rootDir` and `outDir` to any directory in your project you'd like. As of V4.0.0 this package no longer sets them by default due to incompatibilities with some package managers.
 
 ## Feedback and Bugs
 
@@ -36,4 +54,4 @@ 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`. -->
+We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`.

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@nhcarrigan/typescript-config",
+  "version": "4.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": "9"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@codeberg.org:naomi-lgbt/typescript-config.git"
+  },
+  "keywords": [
+    "typescript"
+  ],
+  "author": "Naomi Carrigan",
+  "license": "SEE LICENSE IN https://docs.nhcarrigan.com/#/license",
+  "bugs": {
+    "url": "https://codeberg.org/naomi-lgbt/typescript-config/issues"
+  },
+  "homepage": "https://codeberg.org/naomi-lgbt/typescript-config",
+  "peerDependencies": {
+    "typescript": ">=5.5.2"
+  }
+}

pnpm-lock.yaml

@@ -0,0 +1,24 @@
+lockfileVersion: '9.0'
+
+settings:
+  autoInstallPeers: true
+  excludeLinksFromLockfile: false
+
+importers:
+
+  .:
+    dependencies:
+      typescript:
+        specifier: '>=5.5.2'
+        version: 5.5.2
+
+packages:
+
+  typescript@5.5.2:
+    resolution: {integrity: sha512-NcRtPEOsPFFWjobJEtfihkLCZCXZt/os3zf8nTxjVH3RvTSxjrCamJpbExGvYOF+tFHc3pA65qpdwPbzjohhew==}
+    engines: {node: '>=14.17'}
+    hasBin: true
+
+snapshots:
+
+  typescript@5.5.2: {}

src/index.ts

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

tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "Node",
+    "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
+  }
+}