@tsmodule/tsmodule 28.1.0 → 28.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/templates/default/README.md +8 -3
- package/templates/react/README.md +21 -3
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
var r="@tsmodule/tsmodule",s="node",a="module",d="28.
|
|
2
|
+
var r="@tsmodule/tsmodule",s="node",a="module",d="28.3.0",m="tsmodule/tsmodule",l="TypeScript Module loader and compiler",p="MIT",c={tsmodule:"dist/index.js"},u={".":"./dist/loader/index.js","./*":"./dist/*/index.js","./package.json":"./package.json"},f="dist/types/index.d.ts",g=[{name:"C. Lewis",email:"ctj.lewis@icloud.com",url:"https://ctjlewis.com"}],b=["dist/","templates/"],y={node:">=14"},h={bootstrap:"node bootstrap.js",bootload:"node --no-warnings --loader ./dist/loader/index.js src/index.ts build -r",prebuild:"yarn bootstrap && yarn bootload && yarn link -f",build:"tsmodule build",dev:"tsmodule dev",lint:"eslint --fix src",prepare:"yarn build -r",prepublishOnly:"yarn build && yarn test",pretest:"yarn build -r",test:"ava --no-worker-threads",retest:"SKIP_TEST_SETUP=1 yarn test"},v={"@types/glob":"^7.2.0","@types/node":"^17.0.21","@typescript-eslint/eslint-plugin":"^5.14.0","@typescript-eslint/parser":"^5.14.0",ava:"^4.1.0","await-shell":"^32.0.0",chalk:"^5.0.1",commander:"^9.0.0","create-debug-logger":"^3.0.0",esbuild:"^0.14.25",eslint:"^8.11.0","fast-glob":"^3.2.10","fs-extra":"^10.0.1",glob:"^7.2.0","node-watch":"^0.7.3",ora:"^6.1.0",path:"^0.12.7",typescript:"^4.6.2"},w=["esm","loader","typescript","loader hook","require hook","experimental-loader"],S={timeout:"10 minutes",files:["test/**/*.test.ts"],extensions:{ts:"module"},nodeArguments:["--no-warnings","--loader=@tsmodule/tsmodule"]},R={"@types/fs-extra":"^9.0.13"},n={name:r,platform:s,type:a,version:d,repository:m,description:l,license:p,bin:c,exports:u,types:f,contributors:g,files:b,engines:y,scripts:h,dependencies:v,keywords:w,ava:S,devDependencies:R};import t from"chalk";import{Command as x}from"commander";import{build as B}from"./commands/build/index.js";import{create as C}from"./commands/create/index.js";import{dev as E}from"./commands/dev/index.js";import{execute as T}from"./commands/execute/index.js";import{normalizeImportSpecifiers as A}from"./commands/normalize/index.js";const{version:j}=n,o=new x;o.name(t.white(t.bold("tsmodule"))).usage(t.white(t.bold("<file | command> [options]"))).description(t.blueBright(`A tool for building TypeScript modules.
|
|
3
3
|
|
|
4
4
|
Run TS directly: ${t.bold("tsmodule src/index.ts")}
|
|
5
5
|
Use a command: ${t.bold("tsmodule build")}`)).version(String(j)),o.command("dev").description("Build and watch for changes.").action(E),o.command("build").option("--files <files>","Entrypoints to compile.\r","src/**/*").option("--styles <styles>","Specify stylesheet entrypoint.\r","src/styles/components/index.css").option("-t, --target <target>","ECMAScript featureset to target.\r","esnext").option("-b, --bundle","Bundle dependencies into entrypoints.\r",!1).option("-d, --dev","Build development runtime.\r",!1).option("-r, --runtime-only","Do not emit type declarations, only build JS runtime.\r",!1).option("--stdin [source]","Read from a string or stdin.").option("--stdin-file [file]","File path to mock for stdin.").option("--no-write",`Return code from build() rather than write to disk.
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@ This is a [`tsmodule`](https://github.com/tsmodule/tsmodule) library. By
|
|
|
4
4
|
default, it is assumed to be a Node program, but this can be adjusted via the
|
|
5
5
|
`platform` field in package.json.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### Develop
|
|
8
8
|
|
|
9
9
|
Rebuild on changes with `tsmodule dev` or the `yarn dev` script:
|
|
10
10
|
|
|
@@ -13,7 +13,7 @@ yarn dev
|
|
|
13
13
|
# calls `tsmodule dev`
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
### Export and publish
|
|
17
17
|
|
|
18
18
|
To export your component library, use `tsmodule build` or the `yarn build`
|
|
19
19
|
script:
|
|
@@ -27,4 +27,9 @@ You can then publish to NPM:
|
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
29
|
yarn publish
|
|
30
|
-
```
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
#### Importing from your library
|
|
33
|
+
|
|
34
|
+
All index exports, e.g. `src/example/index.tsx` will be available downstream
|
|
35
|
+
via `import ... from "my-library/example"`.
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
This is a [`tsmodule`](https://github.com/tsmodule/tsmodule) component library
|
|
4
4
|
developed and previewed with Next.js.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
### Develop
|
|
7
7
|
|
|
8
8
|
To start the Next server and develop your components, use `next dev` or the
|
|
9
9
|
`yarn dev` script:
|
|
@@ -13,7 +13,7 @@ yarn dev
|
|
|
13
13
|
# calls `next dev`
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
### Export and publish
|
|
17
17
|
|
|
18
18
|
To export your component library, use `tsmodule build` or the `yarn export`
|
|
19
19
|
script:
|
|
@@ -27,4 +27,22 @@ You can then publish to NPM:
|
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
29
|
yarn publish
|
|
30
|
-
```
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
#### Importing from your component library
|
|
33
|
+
|
|
34
|
+
To reuse your components:
|
|
35
|
+
|
|
36
|
+
1. Import your component styles via `import "my-library/styles"`.
|
|
37
|
+
2. Import your component and render it via `import { MyComponent } from
|
|
38
|
+
"my-library/MyComponent`.
|
|
39
|
+
|
|
40
|
+
#### Footnotes
|
|
41
|
+
|
|
42
|
+
Styles are exported in `dist/`, and are also bundled to `dist/styles.css` from
|
|
43
|
+
the entrypoint given in the `style` package.json.
|
|
44
|
+
|
|
45
|
+
The default behavior is to export all component styles, i.e.
|
|
46
|
+
`src/styles/components/index.css ➞ dist/styles.css`. This can be overridden
|
|
47
|
+
with tsmodule's `--styles` flag, i.e. `tsmodule build --styles
|
|
48
|
+
src/styles/index.css` (which would include all styles in emitted bundle).
|