Skip to content

Add src and out #11

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.

Sign up for GitHub

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 5 commits into from
May 9, 2019
Merged

Add src and out #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71aa597
update globby to avoid error
jonkwheeler May 8, 2019
8deb9f9
fixing up the directories and logging
jonkwheeler May 8, 2019
5ea93cc
cleaning up a bit with verboseLog
jonkwheeler May 9, 2019
8e34c6d
Update README.md
joonhocho May 9, 2019
0bee8de
Update index.ts
joonhocho May 9, 2019
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
65 changes: 49 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,64 @@ yarn add -D tscpaths
## Add it to your build scripts in package.json
```json
"scripts": {
"build": "tsc --project tsconfig.json && tscpaths -p tsconfig.json -s ./src -o ./out",
"build": "tsc --project tsconfig.json && tscpaths --project tsconfig.json",
}
```

### Options
| flag | description |
| ------------ | -------------------------------------------------- |
| -p --project | project configuration file (tsconfig.json) |
| -s --src | source code root directory |
| -o --out | output directory of transpiled code (tsc --outDir) |
## Building only the types
You can also setup a seperate tsconfig file just for types like `tsconfig.types.json` if you are also compiling with Babel.
```json
// tsconfig.types.json
{
"extends": "./tsconfig",
"compilerOptions": {
"module": "amd",
"outDir": "dist",
"rootDir": "./src",
"declaration": true,
"declarationMap": false,
"isolatedModules": false,
"noEmit": false,
"allowJs": false,
"emitDeclarationOnly": true
},
"exclude": ["**/*.test.ts"]
}
```
And then target that
```json
"scripts": {
"build:types": "tsc --project tsconfig.types.json && tscpaths -project tsconfig.types.json",
}
```

You need to provide -s (--src) and -o (--out), because it's hard to predict source and output paths based on tsconfig.json.
Your final build script might look like
```json
"scripts": {
"build": "yarn build:commonjs && yarn build:types",
}
```

I've tried a little and failed. :(
## Options
| flag | description |
| ------------ | ------------------------------------------------------------------------------------ |
| -p --project | project configuration file (tsconfig.json) |
| -s --src | source code root directory (overrides the tsconfig provided) |
| -o --out | output directory of transpiled code (tsc --outDir) (overrides the tsconfig provided) |
| -v --verbose | console.log all the events |

`tsc` does some magic to determine source and output paths and I haven't dived too deep to mimic it.
# Disclaimer
This is not a mature project yet. Pull Requests are welcome!

For now, it's simpler to provide the paths manually.
It works for my setup so far.

If you know how, Pull Requests are welcome!
It may not work correctly if your setup is too complicated, so please do some testing before pushing it to production!!!


# Disclaimer !!!!!
This is not a mature project yet.
# Changelog

It works for my setup so far.
> You need to provide -s (--src) and -o (--out), because it's hard to predict source and output paths based on tsconfig.json.
>
> I've tried a little and failed. :(

It may not work correctly if your setup is too complicated, so please do some testing before pushing it to production!!!
The above is no longer neccesary <-- got you fam: @jonkwheeler
Loading