
build-free-types
by paulirish
paul's fish, bash, git, etc config files. good stuff.
Use Cases
Work Efficiency
Streamline daily tasks and improve productivity.
Project Management
Assist with task management and project tracking.
Team Collaboration
Improve team communication and collaboration.
SKILL.md
name: build-free-types description: This skill should be used when the user asks to "set up types without a build step", "use vanilla JS with types", "configure erasable syntax", or mentions "JSDoc type checking". It provides instructions for modern type safety using JSDoc in browsers and native TypeScript execution in Node.js.
Modern Type Checking (No Build Step)
Configure projects for type safety without a compilation step (tsc/build) by leveraging JSDoc for browser code and Erasable Syntax for Node.js.
Core Philosophy
- Browser (Client-side): Use pure
.jsfiles with JSDoc annotations. This ensures the code runs directly in the browser while maintaining full IDE type support and error checking. - Node.js (Server-side/Tooling): Use
.tsfiles with Erasable Syntax. This allows Node.js (v24.11.0+) to execute TypeScript files directly without a build step, provided they don't use non-erasable features like enums or namespaces.
Configuration Standards
Apply these settings to enable seamless type checking.
1. package.json
Ensure the project is an ES Module and specifies a modern Node.js version.
{
"type": "module",
"engines": {
"node": ">=24.11.0"
},
"scripts": {
"typecheck": "tsc --noEmit"
}
}
2. tsconfig.json
Configure the TypeScript compiler to check JavaScript files and enforce erasable syntax.
{
"compilerOptions": {
"target": "esnext",
"module": "nodenext",
/* Node.js - Native TS Execution Flags */
"erasableSyntaxOnly": true, /* Prevents using unsupported TypeScript features. */
"verbatimModuleSyntax": true, /* Enforces explicit type imports: https://nodejs.org/api/typescript.html#importing-types-without-type-keyword */
"allowImportingTsExtensions": true, /* Allows 'import x from "./file.ts"' */
"rewriteRelativeImportExtensions": true, /* Handle the import adjustment if compiling to JS */
/* Type Checking Strategy */
"noEmit": true,
"allowJs": true,
"checkJs": true,
"strict": true,
"skipLibCheck": true
}
}
Coding Rules
Follow these rules to maintain a build-free environment.
Browser Rules (.js files)
- Use JSDoc for all types: Define variable types, function signatures, and complex objects using JSDoc comments.
- Avoid TS-specific syntax: Do not use
interface,typealiases, or other TypeScript-only syntax in.jsfiles. - Import types correctly: Do NOT use the legacy typedef import (
/** @typedef {import('./types.js').User} User */). Use the modern TS 5.5+ style:/** @import {User} from './types.js' */.
Node.js Rules (.ts files)
- Strictly use Erasable Syntax: Avoid features that require transformation.
- ❌ No
enum - ❌ No
namespaces - ❌ No parameter properties in constructors
- ❌ No
experimentalDecorators
- ❌ No
- Include file extensions: Always include the
.tsextension in import paths:import { x } from './utils.ts'. - Use
import type: Explicitly mark type-only imports to satisfyverbatimModuleSyntax.
Example Files
examples/tsconfig.json- A complete type-checking configuration.
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 1000以上
1ヶ月以内に更新
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon



