Merge pull request #320 from danielpza/@tsconfig/bases

feat: add @tsconfig/bases

Author: orta

.github/workflows/CI.yml

@@ -20,6 +20,13 @@ jobs:
       - name: Create packages for TSConfig JSONs
         run: deno run --allow-read --allow-write --allow-net scripts/create-npm-packages.ts
 
+      - name: Test
+        working-directory: test/
+        run: |
+          corepack enable
+          pnpm install
+          pnpm test
+
       - name: Update the README
         run: deno run --allow-read --allow-write --allow-net scripts/update-markdown-readme.ts
 

.gitignore

@@ -1,3 +1,4 @@
 *.log
 packages/
 .idea/
+node_modules

scripts/create-npm-packages.ts

@@ -15,6 +15,7 @@ for await (const tsconfigEntry of Deno.readDir("bases")) {
   const templateDir = "./template"
   for await (const templateFile of Deno.readDir(templateDir)) {
     if (!templateFile.isFile) continue
+    if (templateFile.name === "README-combined.md") continue // README-combined.md is only for the combined bases
     const templatedFile = path.join(templateDir, templateFile.name)
     Deno.copyFileSync(templatedFile, path.join(packagePath, templateFile.name))
   }
@@ -90,6 +91,8 @@ for await (const tsconfigEntry of Deno.readDir("bases")) {
   console.log("Built:", tsconfigEntry.name);
 }
 
+await buildTsconfigBases()
+
 function isBumpedVersionHigher (packageJSONVersion: string, bumpedVersion: string) {
   const semverMarkersPackageJSON = packageJSONVersion.split('.')
   const semverMarkersBumped = bumpedVersion.split('.')
@@ -101,3 +104,118 @@ function isBumpedVersionHigher (packageJSONVersion: string, bumpedVersion: strin
 
   return true
 }
+
+// build @tsconfig/bases catch all package
+async function buildTsconfigBases() {
+  const name = "bases"
+
+  // Make the folder
+  const packagePath = path.join("packages", name)
+  Deno.mkdirSync(packagePath, { recursive: true })
+
+  // Copy over the template files
+  const templateDir = "./template"
+  for await (const templateFile of Deno.readDir(templateDir)) {
+    if (!templateFile.isFile) continue
+    if (templateFile.name === "README.md") continue
+    const templatedFile = path.join(templateDir, templateFile.name)
+    Deno.copyFileSync(
+      templatedFile,
+      path.join(
+        packagePath,
+        templateFile.name === "README-combined.md" ? "README.md" : templateFile.name,
+      ),
+    )
+  }
+
+  const exportsOverride = {}
+
+  // Copy the tsconfig.json files from all bases
+  for await (const tsconfigEntry of Deno.readDir("bases")) {
+    if (!tsconfigEntry.isFile) continue
+
+    // remove extension
+    const name = tsconfigEntry.name.replace(/\.json$/, "")
+
+    const finalTsconfigFile = `${name}.tsconfig.json`
+
+    // add entry to package.json exports
+    exportsOverride[`./${name}`] = `./${finalTsconfigFile}`
+
+    const tsconfigFilePath = path.join("bases", tsconfigEntry.name)
+
+    const newPackageTSConfigPath = path.join(packagePath, finalTsconfigFile)
+
+    Deno.copyFileSync(tsconfigFilePath, newPackageTSConfigPath)
+
+    const tsconfigText = await Deno.readTextFile(newPackageTSConfigPath)
+
+    // Drop `display` field in tsconfig.json for npm package
+    await Deno.writeTextFile(newPackageTSConfigPath, tsconfigText.replace(/\s*"display.*/, ""))
+  }
+
+  const tsconfigJSON = { display: "Bases" }
+
+  // Edit the package.json
+  const packageText = await Deno.readTextFile(path.join(packagePath, "package.json"))
+  const packageJSON = JSON.parse(packageText)
+  packageJSON.name = `@tsconfig/${name}`
+  packageJSON.description = `Combined tsconfig bases.`
+  packageJSON.keywords = ["tsconfig", name, "combined"]
+  packageJSON.exports = exportsOverride
+
+  // Do some string replacements in the other templated files
+  const replaceTextIn = ["README.md"]
+  for (const filenameToEdit of replaceTextIn) {
+    const fileToEdit = path.join(packagePath, filenameToEdit)
+
+    const defaultTitle = `A base TSConfig for working with ${tsconfigJSON.display}`
+    const title = name !== "recommended" ? defaultTitle : "The recommended base for a TSConfig"
+
+    let packageText = await Deno.readTextFile(fileToEdit)
+    packageText = packageText.replace(/\[filename\]/g, name).replace(/\[display_title\]/g, title)
+
+    // Inject readme-extra if any
+    try {
+      const readmeExtra = (await Deno.readTextFile(path.join("readme-extras", `${name}.md`))).trim()
+
+      if (readmeExtra) {
+        packageText = packageText.replace(/\[readme-extra\]/g, `\n${readmeExtra}\n`)
+      }
+    } catch (error) {
+      // NOOP, there is no extra readme
+      // console.log(error)
+    }
+
+    // Remove readme-extra placeholders if any
+    packageText = packageText.replace(/\[readme-extra\]/g, "")
+
+    await Deno.writeTextFile(fileToEdit, packageText)
+  }
+
+  // Bump the last version of the number from npm,
+  // or use the _version in tsconfig if it's higher,
+  // or default to 1.0.0
+  let version = tsconfigJSON._version || "1.0.0"
+  try {
+    const npmResponse = await fetch(`https://registry.npmjs.org/${packageJSON.name}`)
+    const npmPackage = await npmResponse.json()
+
+    const semverMarkers = npmPackage["dist-tags"].latest.split(".")
+    const bumpedVersion = `${semverMarkers[0]}.${semverMarkers[1]}.${Number(semverMarkers[2]) + 1}`
+    if (isBumpedVersionHigher(version, bumpedVersion)) {
+      version = bumpedVersion
+    }
+  } catch (error) {
+    // NOOP, this is for the first deploy
+    // console.log(error)
+  }
+
+  packageJSON.version = version
+  await Deno.writeTextFile(
+    path.join(packagePath, "package.json"),
+    JSON.stringify(packageJSON, null, "  "),
+  )
+
+  console.log("Built:", "bases")
+}

template/README-combined.md

@@ -0,0 +1,17 @@
+### [display_title].
+
+Add the package to your `"devDependencies"`:
+
+```sh
+npm install --save-dev @tsconfig/[filename]
+yarn add --dev @tsconfig/[filename]
+```
+
+Add to your `tsconfig.json`:
+
+```json
+"extends": "@tsconfig/[filename]/<base>"
+# eg "extends": "@tsconfig/[filename]/node-lts"
+```
+
+You can find the [code here](https://github.com/tsconfig/bases/blob/master/bases/).

test/index.ts

@@ -0,0 +1 @@
+console.log("Hello World")

test/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "test-bases",
+  "scripts": {
+    "test": "tsc --noEmit"
+  },
+  "packageManager": "[email protected]",
+  "devDependencies": {
+    "@tsconfig/bases": "link:../packages/bases",
+    "@types/node": "^24.2.1",
+    "typescript": "^5.9.2"
+  }
+}

test/pnpm-lock.yaml

@@ -0,0 +1,3 @@
+{
+  "extends": ["@tsconfig/bases/node-lts"]
+}