@diahkomalasarinpm/ducimus-placeat-alias NPM

@diahkomalasarinpm/ducimus-placeat-alias

Simple utilities for modern npm packages.

npm install @diahkomalasarinpm/ducimus-placeat-alias -D

Basic usage

# Initialize a new package
pnpx @diahkomalasarinpm/ducimus-placeat-alias@latest init my-package

# In a Node.js package directory with `package.json` present

# Check the package
pkg-utils check

# Build the package
pkg-utils build

# Watch the package
pkg-utils watch

Run pkg-utils -h for more information on CLI usage.

Configuration

@diahkomalasarinpm/ducimus-placeat-alias reads most of its configuration from package.json. But sometimes you need more control. You may then add a configuration file named package.config.ts (or .js, .cjs, or .mjs).

// package.config.ts

import {defineConfig} from '@diahkomalasarinpm/ducimus-placeat-alias'

export default defineConfig({
  extract: {
    rules: {
      // do not require internal members to be prefixed with `_`
      'ae-internal-missing-underscore': 'off',
    },
  },

  // the path to the tsconfig file for distributed builds
  tsconfig: 'tsconfig.dist.json',
})

Options

`bundles`

Type: PkgBundle[]
Default: undefined

An array of entry points to bundle. This is useful if you want to bundle something that should not be exported by the package, e.g. CLI scripts or Node.js workers.

`define`

Type: Record<string, string | number | boolean | null | undefined>
Default: {}

An object defining globals within the package.

`dist`

Type: string
Default: './dist'

The path to the directory to which bundle and chunk files should be written.

`exports`

Type: PkgConfigProperty<PkgExports>
Default: the value of "exports" in package.json

Override or modify the value of the exports before it’s parsed internally.

`extract`

Type:

{
  rules?: {
    'ae-forgotten-export'?: PkgRuleLevel
    'ae-incompatible-release-tags'?: PkgRuleLevel
    'ae-internal-missing-underscore'?: PkgRuleLevel
    'ae-missing-release-tag'?: PkgRuleLevel
  }
}

Default: undefined

Configure the level of reporting of API Extractor (which is used to bundle the type definitions, as well as lint the TSDoc of the package).

`external`

Type: string[]
Default: []

Packages to exclude from bundles.

`jsx`

Type: 'transform' | 'preserve' | 'automatic'
Default: 'automatic'

Strategy for bundling JSX.

`jsxFactory`

Type: string
Default: 'createElement'

The name of the function that creates JSX elements.

`jsxFragment`

Type: string
Default: 'Fragment'

The name of JSX fragment elements.

`jsxImportSource`

Type: string
Default: 'react'

The name of the library from which to import JSX factory and fragment names.

`legacyExports`

Type: boolean
Default: false

Build package with support for legacy exports (writes root <export>.js files). Use this if you need to support older bundlers.

`minify`

Type: boolean
Default: false

Whether to minify the bundled JavaScript.

`rollup.plugins`

Type: PkgConfigProperty<RollupPlugin[]>
Default: []

Rollup plugins to load when bundling.

`runtime`

Type: '*' | 'browser' | 'node'
Default: '*'

Default runtime of package exports

`sourcemap`

Type: boolean
Default: true

Whether to include source map files.

`src`

Type: string
Default: './src'

The path to the directory in which source code is located.

`tsconfig`

Type: string
Default: 'tsconfig.json'

The path to the TypeScript configuration file.

License

MIT

speed random es2015 color ESnext equal awesomesauce deepclone shell includes option getOwnPropertyDescriptor file debug descriptors sameValueZero structuredClone entries class-validator configurable setter await babel tester compare ramda readablestream const bind Array.prototype.findLastIndex ES2021 Observable pure form wrap https some lesscss core connect Object.defineProperty less.js fast-deep-copy colour walking http streams testing ratelimit StyleSheet array RFC-6455 Int8Array Object.values recursive immer test stdlib compile less rangeerror cors trimStart graphql higher-order glob circular fast-copy dataview redux-toolkit serializer rfc4122 patch tape eslintconfig search form-validation deep-copy utilities lazy pipe modules touch korean channel preserve-symlinks i18n which prop consume worker toSorted typesafe slice serialize WeakMap xterm classname computed-types ECMAScript 6 rm -rf react-testing-library _.extend break resolve safe Push gestures once watching [[Prototype]]positive dependency manager wordwrap look lockfile mime-db package manager log hash map argument slot diff drag Array.prototype.includes es-abstract regex task negative spec dataView length performant $.extend vest Object.assign nested css Float64Array uuid language busy jsdom es-shim API less compiler property css variable internal parser regexp has guid ansi Function.prototype.name is every terminal make status getter throttle __proto__format private proto group validation hooks bootstrap less find sort cjk Array.prototype.flat Underscore functional String.prototype.matchAll wait Streams match validator -0 xss core-js chai intrinsic clone toArray transpile phone ES eslint-plugin escape robust events polyfill 3d postcss ES2017 stylesheet spinners redact linux ES2018 symlinks ECMAScript 2022 banner api keys dom-testing-library path Array.prototype.contains iteration style argv signal syntax read private data mime deterministic fp HyBi process emoji linewrap streams2 ES2019 watchFile tc39 ES3 open ajv ArrayBuffer#slice minimal fs Iterator writable buffers iterator TypeBox Array write symbols callbound character remove dir eventEmitter deep-clone ES6 ES8 callback handlers walk types Uint32Array env es8 Object accessibility Uint16Array tools joi visual @@toStringTag rgb ponyfill code points expression byteLength package jest time hookform utils progress codes names CSS number signals find-up URLSearchParams fixed-width contains interrupts middleware compiler Array.prototype.flatMap babel-core drop side tacit pnpm9 ava symlink properties electron shim styleguide argparse es2017 equality ES2022 pretty styles mkdir jsonpath express irq ES2015 key Object.is negative zero typeerror eventDispatcher runtime serialization async offset ECMAScript 3 scheme-validation a11y Object.keys functions Int16Array three callbind less mixins qs ECMAScript 2017 ECMAScript 2016 jwt descriptor hasOwn schema postcss-plugin pose estree rm cli settings reduce bundling dom eslint css less trimLeft windows eslintplugin Object.getPrototypeOf reducer make dir accessor jsx exit watcher iterate sigterm function lru arrays json-schema-validation flatMap RegExp#flags Int32Array filter parse bound hardlinks CSSStyleDeclaration react animation watch batch stateless call-bound css RxJS fastcopy toStringTag protobuf inference chromium util type characters ajax duplex ES2020 traverse call-bind harmony sorted ECMAScript 2015 symbol fullwidth gradients css3 ES2016 buffer starter fantasy-land defineProperty toobject YAML Stream stream RegExp.prototype.flags macos folder es2016 superagent request querystring js trim Microsoft file system concurrency react-hooks mkdirs lint typed ie ES5 jsdiff package.json date password isConcatSpreadable regular expressions commander quote optimist util.inspect readable classes forEach width error-handling deep prune tty superstruct omit promise AsyncIterator autoprefixer picomatch es5 regular Object.fromEntries take helpers encryption typedarrays regular expression assertion WebSocket up censor ECMAScript 2021 mru term framework tostringtag tslib protocol-buffers preprocessor formatting mixins Symbol.toStringTag ES7 extend data bcrypt shebang TypeScript push findup rm -fr Object.entries tdd web colors react uninstall listeners json-schema chrome flag Set getPrototypeOf xhr warning set merge shrinkwrap bdd mobile datastructure byte Symbol airbnb ast get args command-line real-time bluebird findLast validate json-schema-validator throat unicode figlet ECMAScript 2020 nodejs output 256 art styling install efficient ArrayBuffer invariant name performance setPrototypeOf es-shims queueMicrotask javascript sharedarraybuffer browserlist JSON-Schema transpiler parent operating-system styled-components react pose value reuse collection move column ascii sequence wget import getopt es typed array fetch columns rapid installer sanitization crypto module css nesting l10n monorepo immutable less prototype user-streams tap forms gradients css css-in-js persistent Uint8ClampedArray node JSON parents redux ReactiveExtensions authentication inspect emit 6to5 dayjs Observables ECMAScript 7 deepcopy fastify logger waapi exec WeakSet crypt Array.prototype.findLast fast-deep-clone String.prototype.trim typescript sanitize BigUint64Array arktype syntaxerror jsonschema ReactiveX obj whatwg coercible zero rate pyyaml mkdirp assert require workspace:*mocha Promise limit gdpr variables in css text shared libphonenumber matchAll command asserts config fast ecmascript URL chinese Array.prototype.flatten framer zod ECMAScript 2023 ES2023 Rx object matches japanese last optimizer full-width animation typedarray byteOffset from exit-code input scheme flags limited sham yaml directory curl internal slot popmotion flat fastclone fsevents sigint idle client spring classnames concatMap TypedArray url stringify assign ArrayBuffer.prototype.slice prefix generics bootstrap css dotenv string dependencies delete let variables console plugin enumerable react-hook-form yup full trimRight es6 view apollo collection.es6 json look-up cache auth weakmap point-free getintrinsic telephone WebSockets logging bundler browser rmdir copy less css define typeof promises trimEnd groupBy ts fast-clone values browserslist description concat moment Array.prototype.filter utility .env extra extension query metadata create native stringifier npm call es2018

1.0.0

17 days ago