chore: initial commit

Author: TheAlexLichter

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module'
+  },
+  extends: [
+    '@nuxtjs'
+  ]
+}

.gitignore

@@ -0,0 +1,9 @@
+node_modules
+*.iml
+.idea
+*.log*
+.nuxt*
+.vscode
+.DS_STORE
+coverage
+dist

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+node_js:
+- "8"
+- "9"
+- "10"
+cache:
+  yarn: true
+  directories:
+  - node_modules
+install:
+- yarn
+script:
+- yarn test
+after_success:
+- yarn coverage

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Alexander Lichter <[email protected]>
+
+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.

README.md

@@ -0,0 +1,184 @@
+# Nuxt PurgeCSS - Drop superfluous CSS!
+[![npm (scoped with tag)](https://img.shields.io/npm/v/nuxt-purgecss/latest.svg?style=flat-square)](https://npmjs.com/package/nuxt-purgecss)
+[![npm](https://img.shields.io/npm/dt/nuxt-purgecss.svg?style=flat-square)](https://npmjs.com/package/nuxt-purgecss)
+[![Build Status](https://travis-ci.com/Developmint/nuxt-purgecss.svg?branch=master)](https://travis-ci.com/Developmint/nuxt-purgecss)
+[![codecov](https://codecov.io/gh/Developmint/nuxt-purgecss/branch/master/graph/badge.svg)](https://codecov.io/gh/Developmint/nuxt-purgecss)
+[![Dependencies](https://david-dm.org/Developmint/nuxt-purgecss/status.svg?style=flat-square)](https://david-dm.org/Developmint/nuxt-purgecss)
+[![js-standard-style](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com)
+
+>
+
+[📖 **Release Notes**](./CHANGELOG.md)
+
+## Features
+
+* Remove unneeded CSS with ease
+* Webpack or PostCSS mode
+* Already comes with mighty default settings
+* Built on top of [purgecss](https://github.com/FullHuman/purgecss)
+* Nuxt 2 (and only Nuxt 2) support
+* Fully tested!
+
+## Setup
+
+- Add `nuxt-purgecss` dependency using yarn or npm to your project
+- Add `nuxt-purgecss` to `modules` section of `nuxt.config.js`:
+
+```js
+{
+  modules: [
+    'nuxt-purgecss',
+  ],
+
+  purgeCSS: {
+   // your settings here
+  }
+}
+```
+
+## Options
+
+### Defaults
+
+Before diving into the individual attributes, here are the default settings of the module:
+
+```js
+{
+  mode: MODES.webpack,
+  enabled: ({ isDev, isClient }) => (!isDev && isClient),
+  paths: [
+    'components/**/*.vue',
+    'layouts/**/*.vue',
+    'pages/**/*.vue',
+    'plugins/**/*.js'
+  ],
+  styleExtensions: ['.css'],
+  whitelist: ['body', 'html', 'nuxt-progress'],
+  extractors: [
+    {
+      extractor: class {
+        static extract(content) {
+          return content.match(/[A-z0-9-:\\/]+/g)
+        }
+      },
+      extensions: ['html', 'vue', 'js']
+    }
+  ]
+}
+```
+
+This settings should be a good foundation for a variety of projects.
+
+### Merging defaults
+
+You can define every option either as function or as static value (primitives, objects, arrays, ...).
+if you use a function, the default value will be provided as the first argument.
+
+If you *don't* use a function to define you properties, the module will try to
+merge them with the default values. This can be handy for `paths`, `whitelist` and so on because
+the defaults are quite sensible. If you don't want to have the defaults include, just use a function.
+
+### Properties in-depth
+
+#### mode
+
+* Type: `String` (webpack or postcss)
+* Default: `webpack`
+
+Defines the mode, PurgeCSS should be used in.
+
+* Webpack mode can only be used with `build.extractCSS: true`
+* PostCSS mode can only be used with a `build.postcss` **object** (no array) or default settings
+
+#### enabled
+
+* Type: `Boolean` or `Function` (only for webpack mode, will receive the build.extend ctx)
+* Default: `({ isDev, isClient }) => (!isDev && isClient)` (Only activates in production mode)
+
+Enables/Disables the module
+
+* If false, the module won't be activated at all
+* If a function is given, it'll be properly evaluated in webpack mode (in postcss mode it'll be handled as true)
+
+
+#### PurgeCSS options
+
+Please read [the PurgeCSS docs](https://www.purgecss.com/configuration) for information about
+PurgeCSS-related information.
+
+Instead of `content` we use `paths` to specify the paths PurgeCSS should look into (explained [here](https://www.purgecss.com/with-webpack#options).
+This applies to **both modes**, not only to `webpack mode`.
+
+## Examples
+
+### Default setup
+
+```js
+//nuxt.config.js
+export default {
+  modules: [
+    'nuxt-purgecss',
+  ]
+}
+```
+
+### Override a default value
+
+
+```js
+//nuxt.config.js
+export default {
+  modules: [
+    'nuxt-purgecss',
+  ],
+
+  purgeCSS: {
+   whitelist: () => ['only-this-class']
+  }
+}
+```
+
+### Append a value to the defaults
+
+
+```js
+//nuxt.config.js
+export default {
+  modules: [
+    'nuxt-purgecss',
+  ],
+
+  purgeCSS: {
+   whitelist: ['defaults-and-this-class']
+  }
+}
+```
+
+### Override a default value
+
+
+```js
+//nuxt.config.js
+export default {
+  modules: [
+    'nuxt-purgecss',
+  ],
+
+  purgeCSS: {
+   whitelist: (defaultWhitelst) => defaultWhitelst.slice(1)
+  }
+}
+```
+
+
+## Development
+
+- Clone this repository
+- Install dependencies using `yarn install` or `npm install`
+- Start development server using `npm run dev`
+
+## License
+
+[MIT License](./LICENSE)
+
+Copyright (c) Alexander Lichter

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] }

lib/module.js

@@ -0,0 +1,113 @@
+const path = require('path')
+const glob = require('glob-all')
+
+const logger = require('consola').withScope('nuxt-purgecss')
+
+const MODES = {
+  webpack: 'webpack',
+  postcss: 'postcss'
+}
+
+export default function nuxtPurgeCss() {
+  const { srcDir, purgeCSS = {} } = this.options
+
+  logger.start('Loading module')
+
+  const defaults = {
+    mode: MODES.webpack,
+    enabled: ({ isDev, isClient }) => (!isDev && isClient),
+    paths: [
+      'components/**/*.vue',
+      'layouts/**/*.vue',
+      'pages/**/*.vue',
+      'plugins/**/*.js'
+    ],
+    styleExtensions: ['.css'],
+    whitelist: ['body', 'html', 'nuxt-progress'],
+    extractors: [
+      {
+        extractor: class {
+          static extract(content) {
+            return content.match(/[A-z0-9-:\\/]+/g)
+          }
+        },
+        extensions: ['html', 'vue', 'js']
+      }
+    ]
+  }
+
+  /*
+   * Defaults
+   */
+
+  const mergedConfig = Object.entries(purgeCSS).reduce((options, [key, value]) => {
+    const defaultValue = defaults[key]
+
+    if (value && typeof value !== 'function' && Array.isArray(defaultValue)) {
+      // Merge value with default value if array
+      value = defaultValue.concat(value)
+    } else if (typeof value === 'function') {
+      // Executed value functions and provide default value as param
+      value = value(defaultValue)
+    }
+
+    // Finally assign
+    options[key] = value
+    return options
+  }, {})
+
+  const { mode, enabled, ...config } = Object.assign({}, defaults, mergedConfig)
+
+  // transform relative paths
+  config.paths = glob.sync(config.paths.map(p => path.join(srcDir, p)))
+
+  if (!enabled) {
+    logger.warn('Module is not enabled')
+    return
+  }
+
+  if (!Object.values(MODES).includes(mode)) {
+    logger.error(`Could not load PurgeCSS. Invalid type ${mode}.`)
+    return
+  }
+
+  if (mode === MODES.webpack) {
+    if (!this.options.build.extractCSS) {
+      logger.error(`Webpack mode only works with build.extractCSS set to *true*. Either extract your CSS or use 'postcss' mode`)
+      return
+    }
+    this.extendBuild(webpackFn(enabled, config))
+    return
+  }
+
+  if (Array.isArray(this.options.build.postcss)) {
+    logger.error(`build.postcss array option detected. Purgecss will only work in postcss mode with an option object`)
+    return
+  }
+
+  const purgeCssPluginsObject = {
+    '@fullhuman/postcss-purgecss': {
+      content: config.paths,
+      ...config
+    }
+  }
+
+  if (!this.options.build.postcss.plugins || !Object.keys(this.options.build.postcss.plugins).length) {
+    this.options.build.postcss.plugins = {}
+  }
+
+  Object.assign(this.options.build.postcss.plugins, purgeCssPluginsObject)
+
+  logger.success('Module initialized in postcss mode')
+}
+
+const webpackFn = (enabled, purgeCssConfig) => (config, ctx) => {
+  if (typeof enabled === 'function' && !enabled(ctx)) {
+    return
+  }
+  const PurgeCssPlugin = require('purgecss-webpack-plugin')
+  config.plugins.push(new PurgeCssPlugin(purgeCssConfig))
+  logger.success('Module initialized in webpack mode')
+}
+
+module.exports.meta = require('../package.json')