Template TypeScript Node.js package with all the CI bells & whistles I commonly use.
npm i template-typescript-node-package
import { greet } from "template-typescript-node-package";
greet("Hello, world!");
See .github/CONTRIBUTING.md. Thanks!
 Josh Goldberg |
 Jeff Wen |
main branch of the repository.When using this, I didn't know what this meant:
✔ Whether to skip calling the GitHub API (effectively making this a local-only change). · no
I still don't! What does it mean?
The generated project still seems to be not completely initialised. Consider the package.json:
"author": "Josh Goldberg <[email protected]>",
Likewise, the contributors lists Josh Goldberg and not me.
Happy to provide more in depth details
area: documentation
main branch of the repository.I'll want to document what to do to take this template & make a new repo out of it.
At the very least:
template-typescript-node-package to the new name.md filessrc/NPM_TOKEN env variable in settingsGH_TOKEN is available on your account in CI0.1.0 or 0.0.1It's like https://github.com/JoshuaKGoldberg/refined-saved-replies/pull/69 but for this repo. 🙃
This PR adds in a build step to the release.yml so the build artefacts exist for publishing. It also excludes src from publishing as it bloats package size and isn't used.
PR requested here: https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/147#issuecomment-1364555919
It also ensure vitest doesn't try and run tests in the lib folder.
Moves TypeScript interface & type key sorting in ESLint to an override scope so that it only applies to TypeScript files.
released
main branch of the repository.https://typescript-eslint.io/rules/naming-convention is a good rule but requires some configuration. I'll admit, I haven't figured out my preferred config for it yet.
Related: #18
main branch of the repository.It's a simpler name and the "node" part is irrelevant.
No response
area: tooling accepting prsmain branch of the repository.https://github.com/semantic-release/changelog -- let's use it!
No response
main branch of the repository.https://github.com/dustinspecker/awesome-eslint has a huge list of plugins. Let's add in any more that are relevant.
Sibling issue to #16.
releasedmain branch of the repository.The versions in npm and package.json should be in sync.
package.json has 1.12.0...and every time I bump package.json, somehow the npm version gets bumped to one higher. I don't understand. Is there a tag thing wrong somewhere?
No response
type: bug area: tooling accepting prsPending https://github.com/semantic-release/changelog/issues/279 having a resolution, this uses a manual script to swap out \n# for \n## in CHANGELOG.md.
main branch of the repository.TIL that the allcontributors table is sorted by when people are added, not alphabetically. https://github.com/all-contributors/all-contributors/issues/225
https://github.com/all-contributors/cli/pull/249 indicates a contributorsSortAlphabetically option is available.
I like the alphabetical order for a couple reason:
I think this should be roughly a single-line change, right? Adding "contributorsSortAlphabetically": true to the .all-contributorsrc file?
main branch of the repository.From https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/147#issuecomment-1364551999: after running pnpm run setup, all files inside .github should have their contents updated to the new name, repository, etc.
Looks like they're not all updated.
Similar to #155, but for actions.
good first issue type: bug accepting prsmain branch of the repository.From https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/147#issuecomment-1364487493: ${{ secrets.GITHUB_TOKEN }} should already exist. Is asking users to create an ACCESS_TOKEN PAT & using it in release.yml unnecessary work?
It'd be great if we can use the built-in token instead, so users don't have to make a new one.
For context, it's used in release.yml right now to call to the GitHub API for toggling branch protections before & after package releasing.
https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/8c5722e7ccc0fbbec6367bd0cecfc51031c361e1/.github/workflows/release.yml#L42
area: tooling status: needs investigationAdds a section in the README.md that explains them. It gets removed by setup as well.
Also changes the package description to one more distinct from the title. I figured that'd be more clear & easier to understand when reading the docs.
main branch of the repository.In #146, I added an "end-to-end" test script/setup-test-e2e.js for the setup script. It tests that some basic aspects of the script are as expected: that the script doesn't crash, and that it updates a couple values in package.json. More aspects should be tested though!
From https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/147#issuecomment-1364486226: to start, I think the test file should make sure there are no more instances of JoshuaKGoldberg in the repository at all. Doing so would make sure there are no files being missed by the setup script's find-and-replace.
I'm imagining you can probably use a quick shell script to search in files. Or an npm package. Either way 🤷
good first issue area: tooling accepting prs area: testingmain branch of the repository.From #147: if someone is running the setup script, they should be added to the .all-contributorsrc allcontributors config for (I'm thinking to start): code, content, documentation, ideas, infrastructure, maintenance, projectManagement, tool.
See https://allcontributors.org/docs/en/emoji-key for the full allcontributors emoji key.
The setup script already makes sure the user is authenticated with gh. So you can get information on the user by running gh api user in the script.
const user = JSON.parse(await $`gh api user`);
package-fetcher Ce projet contient un boilerplate pour un bot messenger et l'executable Windows ngrok qui va permettre de créer un tunnel https pour c
pi A devtool improve your pakage manager use experience no more care about what package manager is this repo use; one line, try all. Stargazers over t
dmpc Multi-platform node package bundle to a package.json. install ### npm mode npm i -g @kingsword/dmpc ### yarn mode yarn global add @kingsword/dmp
TypeScript Starter Kit This is an opinionated TypeScript Starter kit to help kick-start development of your next npm package. ?? Get Started Luckily,
TypeScript Starter Kit This is an opinionated TypeScript Starter kit to help kick-start development of your next npm package. ?? Get Started Luckily,
Coti cardano-cli A package to run cardano-cli commands from nodejs, if you hold a blockfrost API-KEY you could add while creating a cardano-cli instan
A simple Node.js package that helps you not to look up JavaScript promise syntax every time you use it. Simple: Provides abstraction of the promise sy
dApp Starter The template I use to kickstart all my web3 apps. This starter kit is composed of Next.js and Tailwind CSS, with RainbowKit, ethers, & wa
Vietnamese Bad Words This package is for developers to be able to easily integrate bad word checking into their projects. This package can return bad
Hacktoberfest Submit your Work Hacktoberfest is all about meeting up all brains. In this repository we are planning to come with many ideas and works.
This package is a package to manage cron-jobs in a node.js Typescript application. It is built using node-cron and reflect-metadata packages
An npm package for demonstration purposes using TypeScript to build for both the ECMAScript Module format (i.e. ESM or ES Module) and CommonJS Module format. It can be used in Node.js and browser applications.
EVM-based Smart Contract Scaffold A Typescript Hardhat-based template to develop evm-based smart contracts with all the tooling you need. Features Use
Nodejs Studio Node js package makes creating node js project dependincies files like Controllers,Entities and Repositories easier by executing a few i
Awesome Template Stitches — NextJS, TypeScript, Stitches and Design Tokens Summary About this template Avaliale scripts Other scripts available Main t
Node WebStation Node WebStation is a powerful tool designed for developers to use to create an advanced WebStation for any use all without not having
Node Express & Typescript Starter for 2022 "A minimally opinionated typescript & express starter for 2022" Usage: You should copy .env.sample to .env
api-example-firebase-nodejs A Node.js REST API example built with Express and Typescript that can be used as template for creation of new servers. The
Node.js Template Quickly start a new Node.js project A template for your Node.js projects including Typescript, Eslint, Prettier, Jest and Docker. ⏩ G
2 Mar 29, 2022
11 Nov 1, 2022
2 Oct 16, 2022
7 Sep 27, 2022
6 Aug 10, 2022
9 Oct 8, 2022
364 Dec 18, 2022
8 Nov 3, 2022
3 Oct 5, 2022
7 Jul 17, 2022
57 Dec 28, 2022
8 Oct 24, 2022
9 Oct 12, 2022
14 Dec 29, 2022
2 Jun 4, 2022
12 Dec 15, 2022
5 Nov 25, 2022
2 Oct 12, 2022