0.1.0 • Published 1 year ago

@adchitects/tsup-config v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@adchitects/tsup-config

package version badge

➡️ Extendable tsup configuration, part of the adchitects/configs project.


Prerequisites

node.js version support badge supported tsup version badge

ℹ️ This configuration package require these tools to use locally on your device(s):

  1. node.js icon Latest Node.js LTS (Long-Term Support) version
  2. One of Node.js package managers:
    • pnpm icon
    • yarn icon
    • npm icon
  3. Latest tsup version

Basic usage

👣 Follow the steps below:

  1. Install it with the node.js icon package manager of your choice (in our case, we use pnpm icon).

     pnpm install --save-dev tsup @adchitects/tsup-config
  2. Create a tsup configuration file - tsup.config.ts.

  3. Import a specific getter from this module package configuration and use it.\ NOTE: This one below is an example!

    import { defineConfig } from "tsup";
    
    import { setNodeUniveralOptions } from "@adchitects/tsup-config";
    
    export default defineConfig((options) => ({
    	...setNodeUniveralOptions(options),
    	entry: ["./source/**/*.ts"],
    }));

📖 For the tsup CLI usage, please refer to its documentation.


Available options getters

NamePurpose
getBaseOptions()For general usage
getComponentsOptions()For building a component package
getNodeCJSOptions()For building a Node.js package in CommonJS format
getNodeESMOptions()For building a Node.js package in ES Modules format
getNodeUniveralOptions()For building a Node.js package in both CommonJS and ES Modules format

Used configurations & plugins

Dependencies badge

⚙️ This configuration module loads configurations and plugins options conditionally.

Configurations

None so far.

Plugins

None so far.


Security

workflow security badge

🔐 For more information, please refer to the Security section at the root of the adchitects/configs monorepo.


Contributing

contributors badge

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (adchitects/configs) project's CONTRIBUTING file for more information if you wish to get involved.


License

license badge

⚖️ For more information, please refer to the License section at the root of the adchitects/configs monorepo.


Resources

None so far.