Skip to content

fix: reexport properly for ESM #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"globals": {
"crypto": true
},
"module": true,
"browser": true,
"node": true,
Expand Down
12 changes: 8 additions & 4 deletions bin/jswt-init.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ async function main() {
"./.jshintrc",
[
`{`,
` "globals": {`,
` "crypto": true`,
` },`,
` "module": true,`,
` "browser": true,`,
` "node": true,`,
Expand Down Expand Up @@ -281,10 +284,10 @@ async function main() {
let allArgs = [
"pkg",
"set",
`files[]=index.js`,
`files[]=bin/*.js`,
`files[]=lib/*.js`,
`files[]=tests/*.js`,
`files[]=${mainPath}`,
`files[]=./bin/*.js`,
`files[]=./lib/*.js`,
`files[]=./tests/*.js`,
];
await exec("npm", allArgs);
await sortAndWritePackageJson();
Expand Down Expand Up @@ -750,6 +753,7 @@ async function sortAndWritePackageJson() {
"description",
"main",
"files",
"bin",
"type",
"imports",
"exports",
Expand Down
20 changes: 18 additions & 2 deletions bin/jswt-reexport.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,16 +111,22 @@ async function writeIndexJs(pkgName, indexLines) {
return ".";
});

let mainName = toTitleCase(pkgName);
let lines = [
"// auto-generated by `jswt reexport`",
"// DO NOT EDIT",
"",
`import "${prefix}/${pkgName}.js";`,
`import ${mainName} from "${prefix}/${pkgName}.js";`,
"",
"// these typedef reexports will be available to dependent packages",
"/**",
];
lines = lines.concat(indexLines, [" */", ""]);
lines = lines.concat(indexLines, [
" */",
"",
`export default ${mainName};`,
"",
]);

await Fs.readFile("./index.js", "utf8")
.then(function (txt) {
Expand All @@ -143,6 +149,16 @@ async function writeIndexJs(pkgName, indexLines) {
console.info(`Wrote './index.js' (exports '${prefix}/${pkgName}.js')`);
}

/**
* @param {String} kebab
*/
function toTitleCase(kebab) {
let title = kebab.replace(/(^\w|[\W_]\w)/g, function (match) {
return match.replace(/[\W_]/, "").toUpperCase();
});
return title;
}

async function walkTypeDefs() {
/** @type Array<Typedef> */
let typedefs = [];
Expand Down
11 changes: 0 additions & 11 deletions index.js

This file was deleted.

51 changes: 29 additions & 22 deletions jsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
"target": "es2023", /* 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 TC39 stage 2 draft decorators. */
// "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'. */
Expand All @@ -25,42 +25,47 @@
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "nodenext" /* Specify what module code is generated. */,
"module": "nodenext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "nodenext" /* Specify how TypeScript looks up a file from a given module specifier. */,
"moduleResolution": "nodenext", /* 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. */
"paths": {
"jswt": ["./lib/jswt.js"],
"jswt/*": ["./*"]
}, /* 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": [
"./typings",
"./node_modules/@types"
] /* Specify multiple folders that act like './node_modules/@types'. */,
"typeRoots": ["./typings","./node_modules/@types"], /* 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. */
// "noUncheckedSideEffectImports": true, /* Check side effect 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. */,
"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. */
"noEmit": true, /* Disable emitting files from a compilation. */
// "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": "./", /* 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. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "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. */
Expand All @@ -69,25 +74,27 @@
// "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. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "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. */,
"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. */,
"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. */,
"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. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "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. */,
"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'. */
Expand All @@ -101,7 +108,7 @@

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": [
"*.js",
Expand All @@ -111,4 +118,4 @@
"tests/**/*.js"
],
"exclude": ["node_modules"]
}
}
5 changes: 5 additions & 0 deletions jswt.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
let Jswt = {};

Jswt.answer = 42;

export default Jswt;
5 changes: 0 additions & 5 deletions lib/jswt.js

This file was deleted.

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
{
"name": "jswt",
"version": "2.0.1",
"version": "2.0.2",
"description": "Turn on transpile-free type hinting for your vanilla JS projects #JSWithTypes",
"main": "index.js",
"type": "module",
"main": "./jswt.js",
"files": [
".github/*",
"index.js",
"jswt.js",
"bin/*.js",
"lib/*.js",
"tests/*.js"
Expand All @@ -16,6 +15,14 @@
"init": "bin/jswt-init.js",
"reexport": "bin/jswt-reexport.js"
},
"type": "module",
"imports": {
"jswt": "./jswt.js"
},
"exports": {
".": "./jswt.js",
"./*": "./*"
},
"scripts": {
"bump": "npm version -m \"chore(release): bump to v%s\"",
"fmt": "npm run prettier",
Expand Down Expand Up @@ -49,12 +56,5 @@
"homepage": "https://github.com/BeyondCodeBootcamp/jswt#readme",
"devDependencies": {
"@types/node": "^22.10.2"
},
"exports": {
".": "./lib/jswt.js",
"./*": "./*"
},
"imports": {
"jswt": "./lib/jswt.js"
}
}
Loading