poops 1.0.0

package/.eslintrc.yml

@@ -0,0 +1,10 @@
+env:
+  browser: true
+  commonjs: true
+  es2021: true
+extends: standard
+parserOptions:
+  ecmaVersion: latest
+rules: {
+  space-before-function-paren: ["error", "never"],
+}

package/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  # Maintain dependencies for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    allow:
+      - dependency-type: "production"

package/.github/workflows/npm_publish.yml

@@ -0,0 +1,17 @@
+name: NPM Publish
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    # Setup .npmrc file to publish to npm
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '16.x'
+    - name: Publish to npm registry
+      run: |
+          echo "//registry.npmjs.org/:_authToken=\${{ secrets.NPM_TOKEN }}" >> .npmrc
+          npm publish

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Nikola Stamatović
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,301 @@
+# 💩 Poops
+> A super simple bundler for simple web projects.
+
+----
+
+Intuitive with a minimal learning curve and minimal docs, utilising the most efficient transpilers and compilers available (like [dart-sass](https://sass-lang.com/dart-sass) and [esbuild](https://esbuild.github.io/)) Poop aims to be the simplest bundler option there is. If it's not, please do contribute so we can make it so! 🙏 All ideas and contributions are welcome.
+
+It uses a simple config file where you define your input and output paths and it poops out your bundled files. Simple as that.
+
+## Features
+
+* Bundles SCSS/SASS to CSS
+* Uses [dart-sass](https://sass-lang.com/dart-sass) for SCSS/SASS bundling
+* CSS minification with Nanocss and Autoprefixer via [postcss](https://postcss.org/)
+* Bundles JS/TS to IIFE/ESM/CJS
+* Uses [esbuild](https://esbuild.github.io/) for ES bundling
+* Uses [terser](https://terser.org/) for JS minification and mangling
+* Supports multiple input and output paths
+* Resolves node modules
+* Can add a templatable banner to output files (optional)
+* Supports source maps (optional)
+* Supports minification (optional)
+* Has a configurable local server (optional)
+* Rebuilds on file changes (optional)
+* Live reloads on file changes (optional)
+
+## Quick Start
+You can install Poops globally:
+
+```bash
+npm i -g poops
+```
+
+or locally:
+
+```bash
+npm i -D poops
+```
+
+If you have installed Poops globally, create a `poops.json` configuration file in the project root (see [Configuration](#configuration) on how to configure) and run:
+
+```bash
+s
+```
+
+or pass a custom config. This is usefull when you have multiple environments:
+
+```bash
+poops yourAwesomeConfig.json
+```
+
+If you have installed Poop locally you can run it with `npx poops` or add a script to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "npx poops"
+  }
+}
+```
+
+## Configuration
+
+Configuring Poops is simple 😌. Let's presume that we have a `src/scss` and `src/js` directories and we want to bundle the files into `dist/css` and `dist/js`.
+
+Just create a `poops.json` file in the root of your project and add the following (you can see this sample config in this repo's root):
+
+```json
+{
+  "scripts": [{
+    "in": "src/js/main.ts",
+    "out": "dist/js/scripts.js",
+    "options": {
+      "sourcemap": true,
+      "minify": true,
+      "justMinified": false,
+      "format": "iife",
+      "target": "es2019",
+      "mangle": true
+    }
+  }],
+  "styles": [{
+    "in": "src/scss/index.scss",
+    "out": "dist/css/styles.css",
+    "options": {
+      "sourcemap": true,
+      "minify": true,
+      "justMinified": false
+    }
+  }],
+  "banner": "/* {{ name }} v{{ version }} | {{ homepage }} | {{ license }} License */",
+  "serve" : {
+    "port": 4040,
+    "base": "/"
+  },
+  "livereload": true,
+  "watch": [
+    "src"
+  ],
+  "includePaths": [
+    "node_modules"
+  ]
+}
+```
+
+All config properties are optional except `scripts` or `styles`. You have to specify at least one of them. If you don't have anything to consume, you won't poop. 💩
+
+You can freely remove the properies that you don't need. For example, if you don't want to run a local server, just remove the `serve` property from the config.
+
+### Scripts
+
+Scripts are bundled with [esbuild](https://esbuild.github.io/). You can specify multiple scripts to bundle. Each script has the following properties:
+
+* `in` - the input path, can be an array of file paths, but please just use one file path per script
+* `out` - the output path, can be a directory or a file path, but please just use it as a filename
+* `options` - the options for the bundler. You can apply most of the esbuild options that are not in conflict with Poops. See [esbuild's options](https://esbuild.github.io/api/#build-api) for more info.
+
+Options:
+* `sourcemap` - whether to generate sourcemaps or not, sourcemaps are generated only for non-minified files since they are useful for debugging. Default is `false`
+* `minify` - whether to minify the output or not, minification is performed by Terser and is only applied to non-minified files. Default is `false`
+* `mangle` - whether to mangle the output or not, mangling is performed by Terser and this is the only Terser oprion. Default is `false`
+* `justMinified` - whether you want to have a minified file as output only. Removes the non-minified file from the output. Useful for production builds. Default is `false`
+* `format` - the output format, can be `iife` or `esm` or `cjs` - this is a direct esbuild option
+* `target` - the target for the output, can be `es2018` or `es2019` or `es2020` or `esnext` for instance - this is a direct esbuild option
+
+
+`scripts` property can accept an array of script configurations or just a single script configuration. If you want to bundle multiple scripts, just add them to the `scripts` array:
+
+```json
+{
+  "scripts": [
+    {
+      "in": "src/js/main.ts",
+      "out": "dist/js/scripts.js",
+      "options": {
+        "sourcemap": true,
+        "minify": true,
+        "justMinified": false,
+        "format": "iife",
+        "target": "es2019",
+        "mangle": true
+      }
+    },
+    {
+      "in": "src/js/other.ts",
+      "out": "dist/js/other.js",
+      "options": {
+        "sourcemap": true,
+        "minify": true,
+        "justMinified": false,
+        "format": "iife",
+        "target": "es2019",
+        "mangle": true
+      }
+    }
+  ]
+}
+```
+
+As noted earlier, if you don't want to bundle scripts, just remove the `scripts` property from the config.
+
+### Styles
+
+Styles are bundled with [Dart Sass](https://sass-lang.com/dart-sass). You can specify multiple styles to bundle. Each style has the following properties:
+
+* `in` - the input path, accepts only a path to a file
+* `out` - the output path, can be a directory or a file path, but please just use it as a filename
+* `options` - the options for the bundler.
+
+Options:
+* `sourcemap` - whether to generate sourcemaps or not, sourcemaps are generated only for non-minified files since they are useful for debugging. Default is `false`
+* `minify` - whether to minify the output or not, minification is performed by `cssnano` and is only applied to non-minified files. At the minification step, `autoprefixer` is also applied. Default is `false`
+* `justMinified` - whether you want to have a minified file as output only. Removes the non-minified file from the output. Useful for production builds. Defaults to `false`.
+
+`styles` property can accept an array of style configurations or just a single style configuration. If you want to bundle multiple styles, just add them to the `styles` array:
+
+```json
+{
+  "styles": [
+    {
+      "in": "src/scss/main.scss",
+      "out": "dist/css/styles.css",
+      "options": {
+        "sourcemap": true,
+        "minify": true,
+        "justMinified": false
+      }
+    },
+    {
+      "in": "src/scss/other.scss",
+      "out": "dist/css/other.css",
+      "options": {
+        "sourcemap": true,
+        "minify": true,
+        "justMinified": false
+      }
+    }
+  ]
+}
+```
+
+As noted earlier, if you don't want to bundle styles, just remove the `styles` property from the config.
+
+### Banner (optional)
+
+Here you can specify a banner that will be added to the top of the output files. It is templatable via mustache. The following variables are available from your project's `package.json`:
+
+* `name`
+* `version`
+* `homepage`
+* `license`
+* `author`
+* `description`
+
+If you don't want to add a banner, just remove the `banner` property from the config.
+
+### Local Server (optional)
+Sets up a local server for your project.
+
+Server options:
+* `port` - the port on which the server will run
+* `base` - the base path of the server, where your HTML files are located
+
+If you don't want to run a local server, just remove the `serve` property from the config.
+
+### Live Reload (optional)
+Sets up a livereload server for your project.
+
+Live reload options:
+* `port` - the port on which the livereload server will run
+* `exclude` - an array of files and directories to exclude from livereload
+
+`livereload` can only be `true`, which means that it will run on the default port (`35729`) or you can specify a port:
+
+```json
+{
+  "livereload": {
+    "port": whateverPortYouWant
+  }
+}
+```
+
+You can also exclude files and directories from livereload:
+
+```json
+{
+  "livereload": {
+    "exclude": [
+      "some_directory/**/*",
+      "some_other_directory/**/*"
+    ]
+  }
+}
+```
+
+If you don't want to run livereload, just remove the `livereload` property from the config, or set it to false.
+
+### Watch (optional)
+Sets up a watcher for your project which will rebuild your files on change.
+
+`watch` propery accepts an array of paths to watch for changes. If you want to watch for changes in the `src` directory, just add it to the `watch` array:
+
+```json
+{
+  "watch": [
+    "src"
+  ]
+}
+```
+
+If you don't want to watch for file changes, just remove the `watch` property from the config.
+
+### Include Paths (optional)
+This property is used to specify paths that you want to resolve your imports from. Like `node_modules`. You don't need to specify the `includePaths`, `node_modules` are included by default. But if you do specify `includePaths`, you need to include `node_modules` as well, since this change will override the default behaviour.
+
+Same as `watch` property, `includePaths` accepts an array of paths to include. If you want to include `src` directory, just add it to the `includePaths` array:
+
+```json
+{
+  "includePaths": [
+    "src"
+  ]
+}
+```
+
+## Todo
+
+* [ ] Run esbuild for each input path individually if there are multiple input paths
+* [ ] Styles `in` should be able to support array of inputs like we have it on scripts
+* [ ] Add more argv options like config creation, etc.
+* [ ] Add nunjucs or liquid static templating
+
+## Why?
+
+Why doesn't anyone maintain GULP anymore? Why does Parcel hate config files? Why are Rollup and Webpack so complex to setup for simple tasks? Vite???? What's going on?
+
+I'm tired... Tired of bullshit... I just want to bundle my scss/sass and/or my js/ts to css and iife/esm js, by providing input and output paths for both/one. And to be able to have minimal easily maintainable dependancies. I don't need plugins, I'll add the features manually for the practice I use. That's it. The f**king end.
+
+This is a bundler written by me for myself and those like me. Hopefully it's helpful to you too.
+
+Love :heart: and peace :v:.