@reflex-stack/tsp 0.1.0 → 0.1.2

package/README.md

@@ -1,4 +1,4 @@
-# TSP
+# TypeScript Package (TSP)
 
 **TypeScript Package** (tsp), scaffolds and build **Typescript** sources to **EcmaScript modules** and publish them as modular packages to **NPM** or **JSR**.
 

package/package.json

@@ -1,23 +1,34 @@
 {
-  "name": "@reflex-stack/tsp",
-  "version": "0.1.0",
-  "type": "module",
-  "bin": {
-    "tsp": "./src/cli.js"
-  },
-  "scripts": {
-    "publish": "node ./src/cli.js publish"
-  },
-  "author": "Alexis Bouhet",
-  "license": "MIT",
-  "description": "",
-  "dependencies": {
-    "@types/node": "^22.10.2",
-    "@zouloux/cli": "^0.2.8",
-    "@zouloux/files": "^3.0.4",
-    "brotli-size": "^4.0.0",
-    "stach": "^2.0.1",
-    "terser": "^5.37.0",
-    "typescript": "^5.7.2"
-  }
+	"name": "@reflex-stack/tsp",
+	"version": "0.1.2",
+	"type": "module",
+	"bin": {
+		"tsp": "./src/cli.js"
+	},
+	"exports": {
+		".": "./src/cli.js",
+		"./build": "./src/commands/build.js",
+		"./init": "./src/commands/init.js",
+		"./size-report": "./src/commands/size-report.js",
+		"./tests": "./src/tests.js"
+	},
+	"scripts": {
+		"publish": "node ./src/cli.js publish"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/reflex-stack/tsp"
+	},
+	"author": "Alexis Bouhet",
+	"license": "MIT",
+	"description": "TSP scaffolds and build Typescript sources to EcmaScript modules and publish them as modular packages to NPM",
+	"dependencies": {
+		"@types/node": "^22.10.2",
+		"@zouloux/cli": "^0.2.8",
+		"@zouloux/files": "^3.0.4",
+		"brotli-size": "^4.0.0",
+		"stach": "^2.0.1",
+		"terser": "^5.37.0",
+		"typescript": "^5.7.2"
+	}
 }

package/src/cli.js

@@ -1,15 +1,12 @@
 #!/usr/bin/env sh
 ':' //# comment; exec /usr/bin/env "${RUNTIME:-node}" "$0" "$@"
 
-
 import { askInput, CLICommands, execAsync, nicePrint, oraTask, execSync, table, askList, newLine } from "@zouloux/cli";
 import { build, clearOutput } from "./commands/build.js";
 import { getUserPackageJson, naiveHumanFileSize, showIntroMessage } from "./utils.js";
 import { cleanSizeReports, generateJSON, generateSVGs, sizeReport } from "./commands/size-report.js";
 import { init } from "./commands/init.js";
 import { getConfig } from "./config.js";
-import { test } from "./commands/test.js";
-
 
 // ----------------------------------------------------------------------------- COMMANDS
 
@@ -142,9 +139,25 @@ commands.add("test", async (args, flags, commandName) => {
 	const userPackage = getUserPackageJson()
 	const config = getConfig(userPackage)
 
-	await test( config )
+	nicePrint(`Starting test sequence`)
+	newLine()
+	for ( const testFile of config["test-files"] ) {
+		const command = `${config.runtime} ${config.tests}/${testFile}`
+		nicePrint(`{d}$ ${command}`)
+		try {
+			await execAsync(command, 3)
+		}
+		catch ( error ) {
+			nicePrint(`{b/r}Test ${testFile} failed`, { code: 2 })
+		}
+		newLine()
+	}
+	await oraTask(`All tests passed`, (t) => {t.success()})
 })
 
+/**
+ * PUBLISH COMMAND
+ */
 commands.add("publish", async (args, flags, commandName) => {
 	// Check NPM connected user
 	await oraTask({text: `Connecting to npm`}, async task => {
@@ -215,6 +228,10 @@ commands.add("publish", async (args, flags, commandName) => {
 	}
 })
 
+
+/**
+ * START
+ */
 commands.start(function (commandName) {
 	if ( commandName )
 		return

package/src/commands/init.js

@@ -67,6 +67,9 @@ const tsconfigTemplate = `{
 		// Compilation level target
 		// If using a bundler in your project it should be the previous or current year
 		"target" : "{{esLevel}}",
+		// Allow types to be resolved in tests
+		"checkJs": true,
+		"allowJs": true,
 		// TS libs used, include needed lib.
 		// It should contain the target and "DOM" if it runs in the browser
 		// https://www.typescriptlang.org/tsconfig/#lib
@@ -77,7 +80,7 @@ const tsconfigTemplate = `{
 		"allowImportingTsExtensions": false,
 		// Compiler config
 		"strict": {{tsStrict}},
-		"allowJs": false,
+		"checkJs": true,
 		"useDefineForClassFields" : true,
 		"allowSyntheticDefaultImports": true,
 		// ---
@@ -90,9 +93,17 @@ const tsconfigTemplate = `{
 		// - declaration
 		// - noEmitOnError
 		// - pretty
-	}
-}
-`
+	},
+	// Compile only from src, avoid looping in dist
+	"exclude": ["node_modules", "dist"],
+	"include": ["src/**/*"],
+}`
+
+const tsconfigTestTemplate = `{
+	"extends": "../tsconfig.json",
+	"exclude": ["../node_modules", "../dist", "../src"],
+	"include": ["./**/*"]
+}`
 
 const gitIgnoreTemplate = `.DS_Store
 .idea
@@ -127,9 +138,37 @@ export function subRandomFunction () {
 }
 `
 
-const testFile = `// Write your test file here
-console.log("No test implemented yet")
-process.exit(0)
+const testFile = `// If you have no tests, uncomment this
+// console.log("No test implemented.")
+// process.exit(0)
+
+// Import your code from dist directory, tests are not built on purpose
+import { randomFunction } from "../dist/index.js"
+import { subRandomFunction } from "../dist/submodule/index.js"
+// Import small testing lib from tsp
+import { describe, it, expect, startTest } from "@reflex-stack/tsp/tests"
+
+const endTest = startTest()
+
+describe("Main module", () => {
+	it("Should call random", () => {
+		const rootResult = randomFunction()
+		expect(rootResult).toBe(5)
+	})
+})
+
+describe("Sub module", () => {
+	it("Should call sub random", () => {
+		const rootResult = subRandomFunction()
+		expect(rootResult).toBe(60)
+	})
+	// Test error example
+	// it("Should fail", () => {
+	// 	expect(5).toBe(12)
+	// })
+})
+
+endTest()
 `
 
 export async function init () {
@@ -227,8 +266,9 @@ export async function init () {
 	// Generate src files
 	writeFileSync(join(config.src, "index.ts"), Stach(rootIndexTs, options))
 	writeFileSync(join(config.src, "submodule", "index.ts"), Stach(subModuleIndexTs, options))
-	// Generate test file
+	// Generate tests file
 	writeFileSync(join(config.tests, "test.js"), Stach(testFile, options))
+	writeFileSync(join(config.tests, "tsconfig.json"), Stach(tsconfigTestTemplate, options))
 	// Install dependencies
 	await oraTask("Installing dependencies", async () => {
 		await execAsync(`npm i typescript terser`, false, { cwd: config.cwd })

package/src/tests.js

@@ -0,0 +1,62 @@
+
+
+let total = 0
+let success = 0
+let failed = 0
+
+export function startTest () {
+	total = 0
+	success = 0
+	failed = 0
+	return () => {
+		console.log(`\n${success} / ${total} succeeded with ${failed} error${failed > 1 ? 's' : ''}.`)
+		process.exit( failed )
+	}
+}
+
+
+
+export const describe = ( name, fn ) => {
+	console.log(`${ name }`)
+	fn()
+}
+
+export const it = ( name, fn ) => {
+	++total
+	try {
+		fn()
+		console.log(` - ${ name }`)
+		++success
+	} catch ( e ) {
+		++failed
+		console.log(`❌ ${ name }`)
+		console.error( e )
+	}
+}
+
+export const expect = ( actual ) => ({
+	toBe: ( expected ) => {
+		if ( actual !== expected )
+			throw new Error(`Expected ${ expected } but got ${ actual }`)
+	},
+	toEqual: ( expected ) => {
+		if ( JSON.stringify( actual ) !== JSON.stringify( expected ) )
+			throw new Error(`Expected ${ JSON.stringify( expected ) } but got ${ JSON.stringify( actual ) }`)
+	},
+	toBeTruthy: () => {
+		if ( !actual )
+			throw new Error(`Expected truthy but got ${ actual }`)
+	},
+	toBeFalsy: () => {
+		if ( actual )
+			throw new Error(`Expected falsy but got ${ actual }`)
+	},
+	toThrow: () => {
+		try {
+			actual()
+			throw new Error( 'Expected function to throw' )
+		} catch ( e ) {
+			return true
+		}
+	}
+})

package/src/commands/test.js

@@ -1,20 +0,0 @@
-import { execAsync, newLine, nicePrint, oraTask } from "@zouloux/cli";
-
-
-export async function test ( config ) {
-	nicePrint(`Starting test sequence`)
-	newLine()
-	for ( const testFile of config["test-files"] ) {
-		const command = `${config.runtime} ${config.tests}/${testFile}`
-		nicePrint(`{d}$ ${command}`)
-		try {
-			await execAsync(command, 3)
-		}
-		catch ( error ) {
-			console.error(error)
-			nicePrint(`{b/g}Test ${testFile} failed`, { code: error.code })
-		}
-		newLine()
-	}
-	await oraTask(`All tests passed`, (t) => {t.success()})
-}