TypeScript Boilerplate #17

EdJoPaTo · 2019-02-19T16:02:59Z

Add a TypeScript Boilerplate to create node modules fast.

Current problems I see

These things stop this currently from being a proper boilerplate

xo rules
- ava/no-ignored-test-files see Consider extensions in no-import-test-file rule avajs/eslint-plugin-ava#201
- @typescript-eslint/promise-function-async does not work for me currently. Have not checked for a relevant issue yet.
configuration
- Ava should support typescript without configuration and additional dependencies
- Xo should support typescript without configuration and additional dependencies Built-in support for TypeScript xojs/xo#373

Open questions I have

I would like other thoughts on these one.

Also a cli boilerplate in TypeScript? The main benefit I see is easier and less error prone usage from dependants. The cli does not do many things so I currently don't think it will be as useful as the module itself in TypeScript.
Prepare as build script in package.json. npm-scripts describes prepare, prepack and prepublishOnly. I personally like to check package content via npm pack so prepublishOnly is not helpful here. prepare also runs on a npm install without arguments as its done after a git clone. This might save some time as it hasn't to be done manually but could be annoying on WIP feature branches. The safest solution would be prepack but I think prepare is a nice to have.
Omit index.js / index.d.ts in package.json types and main? This may not be clear to a inexperienced user. Add it or omit it? For example got is currently omitting it.

closes #16

see #16

sindresorhus · 2019-02-27T17:16:17Z

typescript/package.json

+		"test": "xo && ava"
+	},
+	"main": "dist",
+	"types": "dist",


I personally prefer to put non-standard package.json properties at the end.

My idea here is that it nearly does the same as main does.

typescript/source/index.ts

typescript/test/test.ts

sindresorhus · 2019-02-27T17:19:34Z

typescript/package.json

+		"node": ">=6"
+	},
+	"scripts": {
+		"build": "del dist && tsc",


We should open an issue on TypeScript for tsc to get a --cleanup flag or something so we don't need del dist.

By "we", I'm hoping you can do it.

As of reading through a bunch of TypeScript Issues:

They don't like to delete a folder completely (good summary microsoft/TypeScript#13722) but deleting output files when the source files are gone is an ongoing Issue (microsoft/TypeScript#16057).
Sadly this issue is not planned for one of the next releases (attached as a Milestones).

sindresorhus · 2019-02-27T17:19:53Z

typescript/package.json

+	},
+	"scripts": {
+		"build": "del dist && tsc",
+		"prepare": "npm run build",


Why prepare? I usually use prepublishOnly.

Prepare as build script in package.json. npm-scripts describes prepare, prepack and prepublishOnly. I personally like to check package content via npm pack so prepublishOnly is not helpful here. prepare also runs on a npm install without arguments as its done after a git clone. This might save some time as it hasn't to be done manually but could be annoying on WIP feature branches. The safest solution would be prepack but I think prepare is a nice to have.

I changed to prepack as prepare runs into errors with a fresh start repo. As prepare is not needed anyway use prepack as it runs on npm pack and npm publish.

typescript/package.json

sindresorhus · 2019-02-27T17:22:04Z

typescript/package.json

+			"@typescript-eslint/promise-function-async": "off",
+			"ava/no-ignored-test-files": "off"
+		}
+	}


A goal of mine is to get rid of a lot of the config boilerplate here.

Indeed. But sadly we are not there yet. It's currently the way to go so until its possible to do it more clean I would like to keep the current state here. That way everyone can see what still has to be done.

sindresorhus · 2019-02-27T17:25:35Z

Also a cli boilerplate in TypeScript? The main benefit I see is easier and less error prone usage from dependants. The cli does not do many things so I currently don't think it will be as useful as the module itself in TypeScript.

Unless the CLI is large, like XO/AVA large, I will probably not bother to make CLI's in TS.

sindresorhus · 2019-02-27T17:26:24Z

Omit index.js / index.d.ts in package.json types and main? This may not be clear to a inexperienced user. Add it or omit it? For example got is currently omitting it.

This is moot since it's being compiled to dist, so we have to list it.

EdJoPaTo · 2019-03-05T10:37:27Z

Omit index.js / index.d.ts in package.json types and main? This may not be clear to a inexperienced user. Add it or omit it? For example got is currently omitting it.

This is moot since it's being compiled to dist, so we have to list it.

I assume we talked past each other: main and types are needed. But it can be dist/index.js or dist. In the second case NPM will assume the index.js. For new users it might be not clear what is happening there so it could be nice to just write the full form. Omitting it and just write dist looks more clean on the other hand (and that's the way got is going for example).

otherwise the tsc already rejects this

No need to run this at `npm install` and it was prone to errors.

ava itself uses ts-node

Richienb

Since this repository is a template, adding a folder for the typescript version might defeat the point of a "template" since an extra step is added to either expand or remove the folder. I suggest moving this code to a separate template repository.

EdJoPaTo · 2020-01-21T09:02:02Z

@Richienb This PR was added before changing this repo from multiple templates inside folders into multiple templates in multiple repositories.

I followed the migration into a template repository like 90ddca2 did.
Since then the purpose of this repo is a different one so this PR is kinda irrelevant now.

For my typescript template head over to EdJoPaTo/typescript-node-module-boilerplate, PRs and suggestion for improvement welcome :)

begin typescript boilerplate

9451f26

see #16

sindresorhus requested changes Feb 27, 2019

View reviewed changes

EdJoPaTo added 19 commits March 5, 2019 11:40

remove 'use strict' from typescript

ee3d5de

add missing tsconfig.json

66044e1

fix lint (xo) issues

7cdd233

supply expected error message to t.throws directly

d5a13fe

force typescript to allow the bad argument

e54eded

otherwise the tsc already rejects this

use prepack instead of prepare

dfaaa52

No need to run this at `npm install` and it was prone to errors.

dont build on test

1df214a

ava itself uses ts-node

order alphabetically

70ebea1

add commonjs default export support

443b376

use travis-ci.com

64c2c9a

use current NodeJS LTS versions

667a956

update dependencies

4c57b21

remove override of now working rule

83125fa

satisfy peer dependency

13f87ac

upgrade dependencies

388a76c

upgrade dependencies

3ef5897

upgrade dependencies and adapt to eslint 2

2f9526a

upgrade dependencies

b5ce1b3

fixup! upgrade dependencies and adapt to eslint 2

aab0378

Richienb suggested changes Jan 13, 2020

View reviewed changes

EdJoPaTo added 2 commits January 21, 2020 09:06

adapt

41f4b7b

chore: move to main directory

0cd7236

EdJoPaTo closed this Jan 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeScript Boilerplate #17

TypeScript Boilerplate #17

EdJoPaTo commented Feb 19, 2019 •

edited

Loading

sindresorhus Feb 27, 2019

EdJoPaTo Mar 5, 2019

sindresorhus Feb 27, 2019

EdJoPaTo Mar 11, 2019

sindresorhus Feb 27, 2019

EdJoPaTo Mar 5, 2019

EdJoPaTo Mar 11, 2019 •

edited

Loading

sindresorhus Feb 27, 2019

EdJoPaTo Mar 5, 2019

sindresorhus commented Feb 27, 2019

sindresorhus commented Feb 27, 2019

EdJoPaTo commented Mar 5, 2019

Richienb left a comment

EdJoPaTo commented Jan 21, 2020

TypeScript Boilerplate #17

TypeScript Boilerplate #17

Conversation

EdJoPaTo commented Feb 19, 2019 • edited Loading

Current problems I see

Open questions I have

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EdJoPaTo Mar 11, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Feb 27, 2019

sindresorhus commented Feb 27, 2019

EdJoPaTo commented Mar 5, 2019

Richienb left a comment

Choose a reason for hiding this comment

EdJoPaTo commented Jan 21, 2020

EdJoPaTo commented Feb 19, 2019 •

edited

Loading

EdJoPaTo Mar 11, 2019 •

edited

Loading