Package configs ⚙️

Handle package configuration with ease

Table of Content

• Development
  • Local development
  • Production build
  • Unit tests
    • Run tests with coverage
  • Contributing
  • Security
• API Reference
  • Installing optional dependencies
  • TypeScript configurations
    • TypeScript configurations files
    • TypeScript utility functions
  • ESlint configurations
  • Oxlint configurations
  • Prettier configurations
  • Tsdown configurations
  • Vite configurations
  • Markdownlint configurations
• Credits

Development

Run the following to start development

nvm use

pnpm i

Local development

Run the following

pnpm dev

This will generate unminified output code, sourcemaps and will enable source file watcher.

Production build

Run the following to create a local production build

pnpm build

This will generate minified output code without sourcemaps.

Unit tests

Run all the defined test suites by running the following:

# Run tests and watch file changes.
pnpm test:watch

# Run tests in a CI environment.
pnpm test:ci

Run tests with coverage

An HTTP server is then started to serve coverage files from ./coverage folder.

⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.

pnpm test:coverage:serve

Contributing

Contributions are truly welcome!

Please refer to the Contributing Doc for more information on how to start contributing to this project.

Help keep this project up to date with GitHub Sponsor.

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and NOT open a public issue. We will investigate all legitimate reports. Email [email protected] to disclose any security vulnerabilities.

API Reference

Installing optional dependencies

This packages offers a script that will guide you through the installation of dev dependencies based on your current project tooling.

Once you installed @alessiofrittoli/package-configs you can run the following:

node node_modules/@alessiofrittoli/package-configs/scripts/install-dependencies.cjs

TypeScript configurations

This project exports different configurations JSON files as well as some utility functions that you might need in your projects.

TypeScript configurations files

{
  "extends": "@alessiofrittoli/package-configs/tsconfig/base.json",
  "compilerOptions": {
    "paths": {
      "@/*": ["./src/*"]
    }
  }
}

{
  "extends": "@alessiofrittoli/package-configs/tsconfig/react-bundler.json"
}

{
  "extends": "@alessiofrittoli/package-configs/tsconfig/nextjs-bundler.json"
}

TypeScript utility functions

parseTsConfig()

[!WARNING]

@deprecated

This function has been moved to @alessiofrittoli/tsconfig package.

Parse TypeScript configuration file.

import { parseTsConfig } from '@alessiofrittoli/package-configs/tsconfig'

const parsedTsConfig = parseTsConfig({ filepath: './tsconfig.build.json' })

getTSConfigCompilerTarget()

[!WARNING]

@deprecated

This function has been moved to @alessiofrittoli/tsconfig package.

Get TypeScript compiler target from resolved configuration file.

import { getTSConfigCompilerTarget } from '@alessiofrittoli/package-configs/tsconfig'

const compilerTarget = getTSConfigCompilerTarget({
  filepath: './tsconfig.build.json',
})

ESlint configurations

eslintConfig()

Get ESLint base configuration.

// my-project/eslint.config.ts
import { eslintConfig } from "@alessiofrittoli/package-configs/eslint";

export default eslintConfig( {...}, {...} );

// my-project/eslint.config.ts
import { reactProfile } from '@alessiofrittoli/package-configs/eslint/profiles/react'
import { eslintConfig } from '@alessiofrittoli/package-configs/eslint'

export default eslintConfig(...reactProfile)

// my-project/eslint.config.ts
import { nextjsProfile } from '@alessiofrittoli/package-configs/eslint/profiles/nextjs'
import { eslintConfig } from '@alessiofrittoli/package-configs/eslint'

export default eslintConfig(...nextjsProfile)

Oxlint configurations

oxlintConfig()

Get Oxlint base configuration.

// my-project/oxlint.config.ts
import { oxlintConfig } from "@alessiofrittoli/package-configs/oxlint";

export default oxlintConfig( {...} );

Prettier configurations

prettierConfig()

Get Prettier base configuration.

// my-project/prettier.config.ts
import { prettierConfig } from "@alessiofrittoli/package-configs/prettier";

export default prettierConfig( {...} );

Tsdown configurations

tsdownConfig()

Get tsdown base configuration.

// my-project/tsdown.config.ts

import { tsdownConfig } from '@alessiofrittoli/package-configs/tsdown'
import { join, resolve } from 'path'

const tsConfigFile = 'tsconfig.build.json'

export default tsdownConfig(({ outDir = 'example-custom-directory' }) => ({
  tsconfig: resolve(process.cwd(), tsConfigFile),
  outDir,
  copy: [
    {
      from: 'src/assets',
      to: join(outDir, 'assets'),
    },
  ],
}))

Vite configurations

viteConfig()

Get vite base configuration.

// my-project/vite.config.ts

/// <reference types="vitest/config" />
import { viteConfig } from "@alessiofrittoli/package-configs/vite";

export default viteConfig( {...} )

Markdownlint configurations

To help you having a better DX while writing markdown documentations this library provides you a set of base linting rules.

Simply create a .markdownlint.json file at the root of your project and configure it like so:

{
  "extends": "@alessiofrittoli/package-configs/markdownlint/base.json"
}

[!WARNING]

The imported base.json uses https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.41.0/schema/markdownlint-config-schema.json as schema so make sure to add the following setting in your user/project JSON settings file:

{
  "json.schemaDownload.trustedDomains": {
    "https://raw.githubusercontent.com/DavidAnson/markdownlint/": true
  }
}

Made with ☕

Alessio Frittoli https://alessiofrittoli.it | [email protected]