Skip to content

Commit

Permalink
Merge pull request #1067 from ryoppippi/feature/esm
Browse files Browse the repository at this point in the history
feat: Migrate to ESM and use tsup for building
  • Loading branch information
samchon committed Jun 5, 2024
2 parents aec9804 + be37fea commit 04284ef
Show file tree
Hide file tree
Showing 13 changed files with 223 additions and 14 deletions.
4 changes: 2 additions & 2 deletions benchmark/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"suppress-warnings": "^1.0.2",
"tgrid": "^0.10.0",
"ts-node": "^10.9.1",
"ts-patch": "^3.1.0",
"ts-patch": "^3.2.0",
"tstl": "^3.0.0",
"typescript": "^5.3.2",
"uuid": "^8.3.2",
Expand All @@ -73,6 +73,6 @@
"suppress-warnings": "^1.0.2",
"tstl": "^3.0.0",
"uuid": "^9.0.1",
"typia": "../typia-6.0.5.tgz"
"typia": "../typia-6.0.6-dev.20240604.tgz"
}
}
2 changes: 1 addition & 1 deletion debug/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"license": "ISC",
"devDependencies": {
"ts-node": "^10.9.2",
"ts-patch": "^3.1.2",
"ts-patch": "^3.2.0",
"typescript": "^5.4.2"
},
"dependencies": {
Expand Down
1 change: 1 addition & 0 deletions deploy/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ const main = (): void => {
? ["npm run template", "npm run build", "npm start"]
: ["npm run build", "npm start"],
);
test(version)("test-esm")(["npm run build", "npm start"]);
test(version)("errors")(["npm start"]);
test(version)("benchmark")(["npm run build"]);

Expand Down
4 changes: 2 additions & 2 deletions errors/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
"homepage": "https://github.com/samchon/typia#readme",
"devDependencies": {
"rimraf": "^5.0.5",
"ts-patch": "^3.0.2",
"ts-patch": "^3.2.0",
"typescript": "^5.3.2"
},
"dependencies": {
"typia": "../typia-6.0.5.tgz"
"typia": "../typia-6.0.6-dev.20240604.tgz"
}
}
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "typia",
"version": "6.0.5",
"version": "6.0.6-dev.20240604",
"description": "Superfast runtime validators with only one line",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
"module": "lib/index.mjs",
"bin": {
"typia": "./lib/executable/typia.js"
},
Expand All @@ -16,7 +17,7 @@
"test": "npm run package:tgz",
"test:template": "npm run test template",
"-------------------------------------------------": "",
"build": "rimraf lib && tsc",
"build": "rimraf lib && tsc && rollup -c",
"dev": "rimraf lib && tsc --watch",
"eslint": "eslint ./**/*.ts",
"eslint:fix": "eslint ./**/*.ts --fix",
Expand Down Expand Up @@ -75,6 +76,8 @@
"typescript": ">=4.8.0 <5.5.0"
},
"devDependencies": {
"@rollup/plugin-terser": "^0.4.4",
"@rollup/plugin-typescript": "^11.1.6",
"@trivago/prettier-plugin-sort-imports": "^4.3.0",
"@types/inquirer": "^8.2.5",
"@types/node": "^18.15.12",
Expand All @@ -84,6 +87,7 @@
"chalk": "^4.0.0",
"prettier": "^3.2.5",
"rimraf": "^5.0.5",
"rollup": "^4.18.0",
"suppress-warnings": "^1.0.2",
"ts-node": "^10.9.2",
"typescript": "^5.4.5"
Expand Down
7 changes: 4 additions & 3 deletions packages/typescript-json/package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "typescript-json",
"version": "6.0.5",
"version": "6.0.6-dev.20240604",
"description": "Superfast runtime validators with only one line",
"main": "lib/index.js",
"typings": "lib/index.d.ts",
"module": "lib/index.mjs",
"tsp": {
"tscOptions": {
"parseAllJsDoc": true
Expand All @@ -13,7 +14,7 @@
"test": "npm run package:tgz",
"test:template": "npm run test template",
"-------------------------------------------------": "",
"build": "rimraf lib && tsc",
"build": "rimraf lib && tsc && rollup -c",
"dev": "rimraf lib && tsc --watch",
"eslint": "eslint ./**/*.ts",
"eslint:fix": "eslint ./**/*.ts --fix",
Expand Down Expand Up @@ -62,7 +63,7 @@
},
"homepage": "https://typia.io",
"dependencies": {
"typia": "6.0.5"
"typia": "6.0.6-dev.20240604"
},
"peerDependencies": {
"typescript": ">=4.8.0 <5.5.0"
Expand Down
29 changes: 29 additions & 0 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
const typescript = require("@rollup/plugin-typescript");
const terser = require("@rollup/plugin-terser");

module.exports = {
input: "./src/index.ts",
output: {
dir: "lib",
format: "esm",
entryFileNames: "[name].mjs",
sourcemap: true,
},
plugins: [
typescript({
tsconfig: "tsconfig.json",
module: "ES2020",
target: "ES2020",
}),
terser({
format: {
comments: "some",
beautify: true,
ecma: "2020",
},
compress: false,
mangle: false,
module: true,
}),
],
};
41 changes: 41 additions & 0 deletions test-esm/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"private": true,
"type": "module",
"name": "@typia/test-esm",
"version": "0.1.0",
"description": "Test program of ESM for typia",
"main": "bin/index.js",
"tsp": {
"tscOptions": {
"parseAllJsDoc": true
}
},
"scripts": {
"build": "tsc",
"prepare": "ts-patch install",
"start": "node bin"
},
"repository": {
"type": "git",
"url": "https://github.com/samchon/typia"
},
"keywords": [
"typia",
"test"
],
"author": "Jeongho Nam",
"license": "MIT",
"bugs": {
"url": "https://github.com/samchon/typia/issues"
},
"homepage": "https://github.com/samchon/typia#readme",
"devDependencies": {
"@types/cli": "^0.11.25",
"@types/node": "^20.9.4",
"ts-patch": "^3.2.0",
"typescript": "^5.4.5"
},
"dependencies": {
"typia": "../typia-6.0.6-dev.20240604.tgz"
}
}
7 changes: 7 additions & 0 deletions test-esm/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import typia from "typia";

console.log(
typia.is<boolean>(true),
typia.assert<string>("something"),
typia.json.stringify<number>(3),
);
118 changes: 118 additions & 0 deletions test-esm/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "ESNext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./bin", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true, /* Skip type checking all .d.ts files. */
"plugins": [
{
"transform": "typia/lib/transform",
"functional": true,
"numeric": true,
"finite": true,
},
],
},
"include": ["src"],
}
2 changes: 1 addition & 1 deletion test/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@
"suppress-warnings": "^1.0.2",
"tstl": "^3.0.0",
"uuid": "^9.0.1",
"typia": "../typia-6.0.5.tgz"
"typia": "../typia-6.0.6-dev.20240604.tgz"
}
}
8 changes: 8 additions & 0 deletions test/src/features/issues/test_issue_1067_cjs_esm.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ArrayUtil } from "typia/lib/utils/ArrayUtil";

import { TestValidator } from "../../helpers/TestValidator";

export const test_issue_1067_cjs_esm = (): void => {
const values: number[] = ArrayUtil.repeat(10, () => 0);
TestValidator.equals("internal")(values)(new Array(10).fill(0));
};
6 changes: 3 additions & 3 deletions website/pages/docs/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -209,12 +209,12 @@ As `typia` generates optimal operation code through transformation, it must be c
"prepare": "ts-patch install && typia patch"
},
"dependencies": {
"typia": "^4.1.8"
"typia": "^6.0.5"
},
"devDependencies": {
"ts-node": "^10.9.1",
"ts-patch": "^3.0.2",
"typescript": "^5.1.6"
"ts-patch": "^3.2.0",
"typescript": "^5.4.5"
}
}
```
Expand Down

0 comments on commit 04284ef

Please sign in to comment.