poops 1.0.5 → 1.0.7

package/README.md

@@ -1,4 +1,4 @@
-# 💩 Poops [![npm](https://badge.fury.io/js/poops.svg)](https://badge.fury.io/js/poops)
+# 💩 Poops [![npm version](https://img.shields.io/npm/v/poops)](https://www.npmjs.com/package/poops)
 Straightforward, no-bullshit bundler for the web.
 
 > When your day is long
@@ -19,7 +19,7 @@ Straightforward, no-bullshit bundler for the web.
 
 ----
 
-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/)) Poops 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.
+Intuitive with a minimal learning curve and minimal docs, utilizing the most efficient transpilers and compilers available (like [dart-sass](https://sass-lang.com/dart-sass) and [esbuild](https://esbuild.github.io/)) Poops 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.
 
@@ -55,24 +55,20 @@ or locally:
 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:
+If you have installed Poops globally, create a `poops.json` or `💩.json` configuration file in the project root (see [Configuration](#configuration) on how to configure) and run:
 
-```bash
-poops
-```
+`poops` or `💩`
 
-or pass a custom config. This is usefull when you have multiple environments:
+or pass a custom config. This is useful when you have multiple environments:
 
-```bash
-poops yourAwesomeConfig.json
-```
+`poops yourAwesomeConfig.json` or `💩 yourAwesomeConfig.json`
 
-If you have installed Poops locally you can run it with `npx poops` or add a script to your `package.json`:
+If you have installed Poops locally you can run it with `npx poops` or `npx 💩` or add a script to your `package.json`:
 
 ```json
 {
   "scripts": {
-    "build": "npx poops"
+    "build": "npx poops" // or "npx 💩"
   }
 }
 ```
@@ -139,7 +135,7 @@ Just create a `poops.json` file in the root of your project and add the followin
 
 All config properties are optional except `scripts`, `styles` or `markups`. 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.
+You can freely remove the properties 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
 
@@ -149,10 +145,10 @@ Scripts are bundled with [esbuild](https://esbuild.github.io/). You can specify
 * `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`
+**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`. This is a direct esbuild option
 * `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`
+* `mangle` - whether to mangle the output or not, mangling is performed by Terser and this is the only Terser option. 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
@@ -201,7 +197,7 @@ Styles are bundled with [Dart Sass](https://sass-lang.com/dart-sass). You can sp
 * `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:
+**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`.
@@ -239,9 +235,9 @@ As noted earlier, if you don't want to bundle styles, just remove the `styles` p
 
 Poops can generate static pages for you. This feature is still under development, but available for testing from the  v1.0.2. Your markup is templated with [nunjucks](https://mozilla.github.io/nunjucks/). You can specify multiple markup directories to template. **It's currently recommended to specify only one markup directory since this feature is still WIP 🚧.** Each markup directory has the following properties:
 
-* `in` - the input path, can be a directory or a file path, but please just use it as a directory path. All files in this directory will be procided and the structure of the directory will be preserved in the output directory. All direcotries that begin with an underscore `_` will be ignored.
+* `in` - the input path, can be a directory or a file path, but please just use it as a directory path for now. All files in this directory will be processed and the structure of the directory will be preserved in the output directory with exception to directories that begin with an underscore `_` will be ignored.
 * `out` - the output path, can be only a directory path (for now)
-* `site` (otpional) - global data that will be available to all templates in the markup directory. Like site title, description, social media links, etc. You can then use this data in your templates `{{ site.title }}` for instance.
+* `site` (optional) - global data that will be available to all templates in the markup directory. Like site title, description, social media links, etc. You can then use this data in your templates `{{ site.title }}` for instance.
 * `data` (optional) - is an array of JSON or YAML data files, that once loaded will be available to all templates in the markup directory. If you provide a path to a file for instance `links.json` with a `facebook` property, you can then use this data in your templates `{{ links.facebook }}`. The base name of the file will be used as the variable name, with spaces, dashes and dots replaced with underscores. So `the awesome-links.json` will be available as `{{ the_awesome_links.facebook }}` in your templates. The root directory of the data files is `in` directory. So if you have a `data` directory in your `in` directory, you can specify the data files like this `data: ["data/links.json"]`. The same goes for the YAML files.
 * `includePaths` (WIP 🚧) - an array of paths to directories that will be added to the nunjucks include paths. Useful if you want to separate template partials and layouts. For instance, if you have a `_includes` directory with a `header.njk` partial that you want to include in your markup, you can add it to the include paths and then include the templates like this `{% include "header.njk" %}`, without specifying the full path to the partial. This will change in the future, to provide better ignore and include patterns for the markup directories.
 
@@ -353,7 +349,7 @@ If you don't want to run livereload, just remove the `livereload` property from
 ### 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:
+`watch` property 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
 {
@@ -366,7 +362,7 @@ Sets up a watcher for your project which will rebuild your files on change.
 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.
+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 behavior.
 
 Same as `watch` property, `includePaths` accepts an array of paths to include. If you want to include `lib` directory for instance, just add it to the `includePaths` array:
 
@@ -382,7 +378,9 @@ Same as `watch` property, `includePaths` accepts an array of paths to include. I
 
 * [ ] 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
-* [x] Add nunjucs static templating
+* [ ] Build a cli config creation helper tool. If the user doesn't have a config file, we can ask them a few questions and create a config file for them.
+* [ ] Support for LESS styles... I guess...
+* [x] Add nunjucks static templating
   * [ ] Refactor nunjucks implementation
   * [ ] Complete documentation for nunjucks
   * [ ] Add markdown support
@@ -396,7 +394,7 @@ Same as `watch` property, `includePaths` accepts an array of paths to include. I
 
 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.
+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 dependencies. I don't need plugins, I'll add the features manually for the practice I use. That's it. The f**king end.
 
 To better illustrate it, here is a sample diff of Poops replacing Rollup:
 

package/example/dist/css/styles.css

@@ -1,4 +1,4 @@
-/* poops v1.0.5 | https://github.com/stamat/poops | MIT License */
+/* poops v1.0.7 | https://github.com/stamat/poops | MIT License */
 /*
  * SIZES
  */
@@ -17634,7 +17634,6 @@ body {
   margin: 0;
   padding: 0;
   font-family: "DM Sans", Helvetica, Arial, sans-serif !important;
-  font-size: 24px !important;
   line-height: 1.5;
 }
 
@@ -17645,7 +17644,6 @@ header {
 header h1 {
   font-family: "Poppins", Helvetica, Arial, sans-serif !important;
   font-weight: 700 !important;
-  font-size: 94px;
   line-height: 1;
   margin: 0;
   color: #824F2D;
@@ -17654,6 +17652,14 @@ header h1 {
 #poop {
   font-size: 10rem;
   display: inline-block;
-  margin-bottom: 24px;
+}
+
+code.terminal::before {
+  content: "$ ";
+  opacity: 0.5;
+}
+
+a {
+  color: #824F2D;
 }
 /*# sourceMappingURL=styles.css.map */