hotell / typescript-lib-starter Goto Github PK

Feature request

Use case(s)

https://2ality.com/2019/10/hybrid-npm-packages.html

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

Your Greenkeeper Bot 🌴

Feature request

Use case(s)

It's 2019 already huh! cloning repos manually is kinda "old school/cumbersome".

We should support modern project bootstraping experience, like yarn create or npx create-typescript-lib.

Work that needs to be done:

TODO:

• change package name, to contain create prefix (@martin_hotell/create-typescript-lib)
• publish bin script to npm

How would bin work?:

• here is most simple implementation that comes up on my mind:

the package would just clone this repo and execute init script

Feature request

This repo seems to be a nice template.
GitHub created new feature Templates I think it will be nice to switch it on for this repo :)
For example:

Also, do you want me to add linting of TS using ESLint? :) I can :)

Ahoj Martine!

It will be great if most of tools can work just as expected by running them.
What I can see in package.json scripts — there are mostly explicit calls with loading args from ./config/…

It isn't good for almost everyone who use command line ;-)

I expect that root folder will be bloated with hidden dot files — like:

• .gitignore
• .editorconfig
• .npmignore, .npmrc
• .prettierrc.js, .prettierignore
• .travis.yml
• .yarnrc ?
• … I can imagine another

but, seriously, really… I thing it is worse to keep expected config files outside than add them to their default path. Tools will be happy with everything in implicit path and tooling will behave more correctly with editors.

So, please, consider move everything which must be specified explicitly in package.json to the root,
if possible, remove config dir entirely — files inside IMHO can be moved on better path with much better semantic meaning

Feature request

Use case(s)

Currently when used runs yarn after clone and terminates prompts, "initialization" process will run anyways with destructive consequences ( removed files... re-initialised git etc).

All that needs to be done is to handle CTRL+C gracefully -> just terminate without executing the script logic

Feature request

Use case(s)

we are not updating tslint.json in existing project. Currently migrate script just echoes that nothing was updated, because it does no-op. This should be fixed/implemented. All we need to do is to find out how to properly merge .jsonc files ( json files with comments )

Just a feedback:

• since this is a typescript related library, It would be awesome that the devtools also use TypeScript. In particular config/rollup.config.js is hard to follow due to the jsdoc. For scripts you can use ts-node for run the typescript directly but you will need to transpile them in order to the tools like rollup, jest, etc to "undertand" the config (or maybe not if using valid js?)

• you are targeting es5 which is fine but for those which can target more than that it won't work because rollup-plugin-uglify doesn't understand es6. using rollup-plugin-uglify-es will work for all.

• I think jest-puppeteer can be easily added to run the specs in the browser too

• (more ambitious) would be awesome to use yeoman generator to ask: library name, target js version, if install jest and tests or not, if install lint tool, travis, etc. In my case I only needed the tsc & rollup part. Maybe this could be another project and use this one as a template

Just a feedback, the tool is very helpful and the project has lot of quality. I was looking for building libraries written with typescript, bundling in different module formats and didn't found much since in general people bundle applications not libraries . Congrats, keep it up - you can close this. Sorry for the noise

Hi
you are forcing VSCode users to:

  "typescript.referencesCodeLens.enabled": true,
  "javascript.referencesCodeLens.enabled": true,

As I can imagine — it can be very powerful tool. But it doesn't work for me and I must explicitly disable it.

Will be much better to instruct people how to turn this on instead of letting us (scratching on the head) what is that 0 references disturbing line…

Feature request

Use case(s)

support monorepo setup on init.

https://github.com/Hotell/ts-setup already uses this starter with various tweaks. It would be nice to incorporate those, so use would get asked during init if he wan't to create monorepo or standard single repo.

• this will lower library size, because webpack boilerplate would be not needed anymore for simulating import/export
• also consumer bundler will process just one file so bundling will be much quicker
• leverage uglify-es for minifying es2015 code

make no mistake, all of this is already possible with rollup, but since we are using webpack here well ... :) 👍

Feature request

Use case(s)

It's not very user friendly to manually set library name after fork etc. A yarn init after cloning the project would be definitely much better experience

Bug report

• {package-name} version: x.x.x ()

Current behaviour

When I first pack, there will be a file loss. If I copy the CHANGELOG.md file back, it's normal.

npm run build

> [email protected] prebuild /Volumes/MAC1/file/test/npm/typescript-lib-starter
> npm run cleanup && npm run verify


> [email protected] cleanup /Volumes/MAC1/file/test/npm/typescript-lib-starter
> shx rm -rf dist


> [email protected] verify /Volumes/MAC1/file/test/npm/typescript-lib-starter
> npm run validate-js && npm run style && npm run test:ci


> [email protected] validate-js /Volumes/MAC1/file/test/npm/typescript-lib-starter
> tsc -p ./config && tsc -p ./scripts


> [email protected] style /Volumes/MAC1/file/test/npm/typescript-lib-starter
> npm run format -- --list-different && npm run lint


> [email protected] format /Volumes/MAC1/file/test/npm/typescript-lib-starter
> prettier "**/*.{ts,tsx,js,jsx,css,scss,sass,less,md}" "--list-different"


> [email protected] lint /Volumes/MAC1/file/test/npm/typescript-lib-starter
> tslint --project tsconfig.json --format codeFrame


> [email protected] test:ci /Volumes/MAC1/file/test/npm/typescript-lib-starter
> npm t -- --ci


> [email protected] test /Volumes/MAC1/file/test/npm/typescript-lib-starter
> jest -c ./config/jest.config.js "--ci"

 PASS  src/__tests__/greeter.spec.ts
  Greeter
    ✓ should greet (3ms)
    ✓ should greet and print deprecation message if in dev mode (9ms)

  console.warn node_modules/jest-mock/build/index.js:711
    this method is deprecated, use #greet instead

Test Suites: 1 passed, 1 total
Tests:       2 passed, 2 total
Snapshots:   0 total
Time:        4.048s
Ran all test suites.

> [email protected] build /Volumes/MAC1/file/test/npm/typescript-lib-starter
> tsc && tsc --target es2018 --outDir dist/esm2015 && rollup -c config/rollup.config.js && rollup -c config/rollup.config.js --environment NODE_ENV:production


/Volumes/MAC1/file/test/npm/typescript-lib-starter/dist/esm5/index.js → dist/bundles/index.umd.js...
created dist/bundles/index.umd.js in 28ms

/Volumes/MAC1/file/test/npm/typescript-lib-starter/dist/esm2015/index.js → dist/bundles/index.esm.js...
created dist/bundles/index.esm.js in 8ms

/Volumes/MAC1/file/test/npm/typescript-lib-starter/dist/esm5/index.js → dist/bundles/index.umd.min.js...
created dist/bundles/index.umd.min.js in 259ms

/Volumes/MAC1/file/test/npm/typescript-lib-starter/dist/esm2015/index.js → dist/bundles/index.esm.min.js...
created dist/bundles/index.esm.min.js in 182ms

> [email protected] postbuild /Volumes/MAC1/file/test/npm/typescript-lib-starter
> node scripts/copy && npm run size

fs.js:119
    throw err;
    ^

Error: ENOENT: no such file or directory, copyfile '/Volumes/MAC1/file/test/npm/typescript-lib-starter/CHANGELOG.md' -> '/Volumes/MAC1/file/test/npm/typescript-lib-starter/dist/CHANGELOG.md'
    at copyFileSync (fs.js:1743:3)
    at source.forEach (/Volumes/MAC1/file/test/npm/typescript-lib-starter/scripts/copy.js:43:7)
    at Array.forEach (<anonymous>)
    at cp (/Volumes/MAC1/file/test/npm/typescript-lib-starter/scripts/copy.js:42:12)
    at main (/Volumes/MAC1/file/test/npm/typescript-lib-starter/scripts/copy.js:22:3)
    at Object.<anonymous> (/Volumes/MAC1/file/test/npm/typescript-lib-starter/scripts/copy.js:11:1)
    at Module._compile (internal/modules/cjs/loader.js:738:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:749:10)
    at Module.load (internal/modules/cjs/loader.js:630:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:570:12)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] postbuild: `node scripts/copy && npm run size`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] postbuild script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/wsx/.npm/_logs/2019-03-04T01_33_39_760Z-debug.log

Expected behaviour

Please explain how you'd expect it to behave.

Feature request

Use case(s)

Explain the rationale for this feature.