Code Monkey home page Code Monkey logo

packsy's Introduction

๐Ÿ“ฆ Packsy

This package helps you to set up a new npm package blazing fast. Use eslint, prettier, babel and rollup with zero configuration.

๐Ÿ›  See packsy-starter for usage example and starter kit.

Installation

npm install packsy
# or
yarn add packsy

Commands

Name Description
packsy build Builds production ready bundles with Rollup. Output directory is dist.
packsy dev Compiles files for development with Babel. Output directory is lib.
packsy format Formats all files. All Prettier cli options can be used.
packsy lint Lints all files. All ESLint cli options can be used.
packsy pre-commit Formats and lints all staged files, validates package.json.
packsy validate Lints all files. validates package.json.

Prettier and ESLint configs

The package provides a default Prettier and ESLint configuration. See .prettierrc.js and .eslintrc.js in packsy-starter for usage.

Development workflow (linked package)

Link the package as usual using yarn's or npm's link/unlink commands first. Then execute packsy dev.

packsy dev compiles all files with babel in watch mode, so that a file will be compiled every time that you change it.

Projects that use Packsy

FAQ

What is the difference between packsy build and packsy dev?

First the output folders are different (dist for build and lib for dev command). Second the build command uses Rollup (with Babel) while dev uses only Babel. Using only Babel leads to faster compile times, which is useful for development. Also the dev command uses the watch mode of Babel.

Inspiration

This package is inspired by Kent C. Dodds's awesome package kcd-scripts.

License

This package is released under the MIT License.

packsy's People

Contributors

markusjwetzel avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

isabella232

packsy's Issues

logo contribution

Hi @markusjwetzel I contribute to open source projects to support. I have a good logo idea in my mind for packsy. Would you like to see this? Have a nice day.

Add size-snapshot.json automatically on release

When executing yarn publish, yarn will create a new commit with an updated package.json automatically. We should add the updated size-snapshot.json to these commits as well. We can do that by staging the file (i.e. executing git add size-snapshot.json) in a packsy build command.

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.