Skip to content

Commit

Permalink
📝 Improve docs (v0.0.8)
Browse files Browse the repository at this point in the history
  • Loading branch information
CryogenicPlanet committed Dec 12, 2021
1 parent 0a4b9e5 commit a4dc477
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
15 changes: 9 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Zero Config Modern Typescript Projects
# Tsdev (Zero Config Modern Typescript Projects)


## Motivation

I really like the idea behind https://github.com/jaredpalmer/tsdx but I find it uses older tools and it ends up taking time for me to setup my typescript packages anyways. So I wanted to make something like it that fit my stack and preferred tools better, something that obfuscates all the configuration needed to run modern typescript applications and allows use to get started instantly.

Expand Down Expand Up @@ -28,12 +31,12 @@ tsdev create {name}


```
➜ tsdev --help
➜ tsdev --help
NAME:
tsdev - Zero config modern typescript tooling
USAGE:
tsdev [global options] command [command options] [arguments...]
tsdev [global options] command [command options] Run a .ts file with zero config directly
COMMANDS:
create Create a new application
Expand All @@ -44,7 +47,7 @@ COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)
--watch Run in watch mode (default: false)
```

## Templates
Expand All @@ -63,8 +66,8 @@ Some of these might happen sooner than others. If you want something to be prior
- [] Add `graphql` template using [tsgql](https://github.com/modfy/tsgql). This will be `graphql` without having to write any `graphql` code at all, just typescript.
- [] Add `prisma` batteries
- [] Add support for all nextjs examples from https://github.com/vercel/next.js/tree/canary/examples
- [] `tsdev filename` Automatically run any `.ts` or `.tsx` file with zero config
- The `.ts` part of this is easy, it is basically what `tsdev dev filename` is
- [x] `tsdev filename` Automatically run any `.ts` or `.tsx` file with zero config
- [x] The `.ts` part of this is easy, it is basically what `tsdev dev filename` is
- The `.tsx` part is a bit more complicated, and will require making a custom version of `vite` that just runs file without a config file or a `.html` file or having to use `react-dom` yourself
- [] Make `vite` default template use filesystem routing
- [] Clone [`bun run` feature](https://twitter.com/jarredsumner/status/1454218996983623685?s=20) to allow really fast `npm run commands`
Expand Down
3 changes: 2 additions & 1 deletion cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,11 @@ func SetupCliApp() (cli.App, error) {
}

app := &cli.App{
Name: "tsdx++",
Name: "tsdev",
Commands: cliCommands,
Usage: "Zero config modern typescript tooling",
EnableBashCompletion: true,
ArgsUsage: "Run a .ts file with zero config directly",
Action: func(c *cli.Context) error {

return commands.HandleDefault(c.Bool("watch"), c.Args().Slice())
Expand Down
2 changes: 1 addition & 1 deletion installer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "tsdev-installer",
"version": "0.0.7",
"version": "0.0.8",
"description": "The installer for tsdev, a better tsdx",
"scripts": {
"postinstall": "node dist/postinstall.js install",
Expand Down

0 comments on commit a4dc477

Please sign in to comment.