starter-world
v0.1.44
Published
A pnpm workspace boilerplate for Typescript projects.
Downloads
106
Readme
workspace
A pnpm workspace boilerplate for Typescript projects.
Features
- Managed with
pnpm
, ensuring efficient package management. - ESLint configuration extending
eslint-config-dsfx3d
. - Sample module
foo
exported in the main index.
Workspace Structure
The workspace is structured as follows:
- Main packages are located in the
packages/
directory. - Additional components can be added in the
components/
directory. - Packages inside
test
directories are excluded.
Installation
To set up the workspace:
pnpm bootstrap
Scripts
bootstrap
: Update packages and install Husky hooks.
Dependencies
- Development:
@commitlint/cli
@commitlint/config-conventional
eslint
eslint-config-dsfx3d
husky
prettier
typescript
packageName
This is my package description.
Usage
Install package:
# npm
npm install packageName
# yarn
yarn add packageName
# pnpm
pnpm install packageName
Import:
// ESM
import {} from "packageName";
// CommonJS
const {} = require("packageName");
Development
- Clone this repository
- Install latest LTS version of Node.js
- Enable Corepack using
corepack enable
- Install dependencies using
pnpm install
- Run interactive tests using
pnpm dev
License
Made with 💛
Published under MIT License.