Git Product home page Git Product logo

rollup-plugin-package-json-sanitize's Introduction

rollup-plugin-package-json-sanitize

This is a rollup plugin to clean several sections from a package.json during build process before publishing it.

Content

Table of Contents

Usage

Parameters

Name Required Type Default Description
sourceFilePath false string ./package.json The package.json which should be sanitized
targetDirectory false string ./dist The destination directory name
targetFileName false string package.json The name of your destination file
config true Object - The plugin configuration for sanitizing the package.json

Supported Configuration

remove

  • The remove operation can be used to remove properties and according values from a package.json file. The properties to remove are declared as string[] (Array<string>)

Example configuration

The plugin can simply added to your existing rollup.config.js configuration file:

...
import cleanPackageJson from "rollup-plugin-package-json-sanitize";
...

export default {
  input: "src/index.ts",

    ...

  },
  plugins: [

    ...

    cleanPackageJson({
      sourceFilePath: "./package.json",
      targetDirectory: "./dist",
      targetFileName: "package.json",
      config: [
        {
          operation: "remove",
          propertyNames: ["dependencies", "devDependencies", "scripts"],
        },
      ],
    }),

    ...


  ],
};

Development

Build

  1. Install depencencies

    npm install
    
  2. Build the package as prod

    npm run build
    
    # npm run build:dev # For debugging purpose
    
    

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.