Skip to content

README.md

Latest commit

 

History

History
76 lines (53 loc) · 1.73 KB

README.md

File metadata and controls

76 lines (53 loc) · 1.73 KB

parcel-preact-typescript

Simple set-up using Parcel, Preact X and TypeScript.

This template provides the simplest possible set-up that combines Parcel, Preact X and TypeScript. Jest is used for testing.

Getting started

Clone the repository and install its dependencies.

git clone git@github.com:metonym/parcel-preact-typescript.git
cd parcel-preact-typescript
yarn install

Available scripts

yarn start

Runs the app in development mode. Visit http://localhost:1234.

yarn build

Builds the project for production. The build directory is dist; types will be written to dist/index.d.ts. Customize the build directory in the outDir configuration option in the tsconfig.json.

yarn test

Run the tests using the jest JavaScript testing framework.

The jest configuration for this project is in package.json:

"jest": {
  "preset": "ts-jest"
}

Customizing tsconfig.json

The default tsconfig.json contains the following:

// tsconfig.json
{
  "compilerOptions": {
    "esModuleInterop": true,
    "jsx": "react",
    "jsxFactory": "h",
    "lib": ["dom", "esnext"],
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "target": "es5"
  },
  "include": ["src"]
}

Note that jsxFactory must be "h" in order for preact to work with parcel.

Decorators

Enable decorators (stage 2) by setting compilerOptions.experimentalDecorators to true:

{
  "compilerOptions": {
    "experimentalDecorators": true
  }
}

License

MIT