first commit

Sébastien Chopin · Sébastien Chopin · commit cf320316e167 · 2019-04-04T11:46:34.000+02:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,38 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node
+    steps:
+      # Checkout repository
+      - checkout
+
+      # Restore cache
+      - restore_cache:
+          key: yarn-cache-{{ checksum "yarn.lock" }}
+
+      # Install dependencies
+      - run:
+          name: Install Dependencies
+          command: NODE_ENV=dev yarn
+
+      # Keep cache
+      - save_cache:
+          key: yarn-cache-{{ checksum "yarn.lock" }}
+          paths:
+            - "node_modules"
+
+      # Lint
+      - run:
+          name: Lint
+          command: yarn lint
+
+      # Tests
+      - run:
+          name: Tests
+          command: yarn jest
+
+      # Coverage
+      - run:
+          name: Coverage
+          command: yarn codecov
diff --git a/.editorconfig b/.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
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,8 @@
+# Common
+node_modules
+dist
+.nuxt
+coverage
+
+# Plugin
+lib/plugin.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module'
+  },
+  extends: [
+    '@nuxtjs'
+  ]
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+node_modules
+*.iml
+.idea
+*.log*
+.nuxt
+.vscode
+.DS_Store
+coverage
+dist
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Sébastien Chopin <seb@chopin.io>
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,61 @@
+# nuxt-tailwindcss
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Circle CI][circle-ci-src]][circle-ci-href]
+[![Codecov][codecov-src]][codecov-href]
+[![Dependencies][david-dm-src]][david-dm-href]
+[![Standard JS][standard-js-src]][standard-js-href]
+
+> TailwindCSS module for Nuxt.js
+
+[📖 **Release Notes**](./CHANGELOG.md)
+
+## Setup
+
+1. Add the `nuxt-tailwindcss` dependency with `yarn` or `npm` to your project
+2. Add `nuxt-tailwindcss` to the `modules` section of `nuxt.config.js`
+3. Configure it:
+
+```js
+{
+  modules: [
+    // Simple usage
+    'nuxt-tailwindcss',
+
+    // With options
+    ['nuxt-tailwindcss', { /* module options */ }]
+  ]
+}
+```
+
+## Development
+
+1. Clone this repository
+2. Install dependencies using `yarn install` or `npm install`
+3. Start development server using `npm run dev`
+
+## License
+
+[MIT License](./LICENSE)
+
+Copyright (c) Sébastien Chopin <seb@chopin.io>
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/dt/nuxt-tailwindcss.svg?style=flat-square
+[npm-version-href]: https://npmjs.com/package/nuxt-tailwindcss
+
+[npm-downloads-src]: https://img.shields.io/npm/v/nuxt-tailwindcss/latest.svg?style=flat-square
+[npm-downloads-href]: https://npmjs.com/package/nuxt-tailwindcss
+
+[circle-ci-src]: https://img.shields.io/circleci/project/github/nuxt-community/tailwindcss.svg?style=flat-square
+[circle-ci-href]: https://circleci.com/gh/nuxt-community/tailwindcss
+
+[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/tailwindcss.svg?style=flat-square
+[codecov-href]: https://codecov.io/gh/nuxt-community/tailwindcss
+
+[david-dm-src]: https://david-dm.org/nuxt-community/tailwindcss/status.svg?style=flat-square
+[david-dm-href]: https://david-dm.org/nuxt-community/tailwindcss
+
+[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square
+[standard-js-href]: https://standardjs.com
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,11 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env', {
+        targets: {
+          esmodules: true
+        }
+      }
+    ]
+  ]
+}
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  extends: [
+    '@commitlint/config-conventional'
+  ]
+}
diff --git a/example/assets/css/tailwind.css b/example/assets/css/tailwind.css
@@ -0,0 +1,3 @@
+@import 'tailwindcss/base';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';
diff --git a/example/nuxt.config.js b/example/nuxt.config.js
@@ -0,0 +1,13 @@
+const { resolve } = require('path')
+
+module.exports = {
+  rootDir: resolve(__dirname, '..'),
+  buildDir: resolve(__dirname, '.nuxt'),
+  srcDir: __dirname,
+  render: {
+    resourceHints: false
+  },
+  modules: [
+    resolve(__dirname, '../')
+  ]
+}
diff --git a/example/pages/index.vue b/example/pages/index.vue
@@ -0,0 +1,15 @@
+<template>
+  <div class="bg-indigo-900 text-center py-4 lg:px-4">
+    <div class="p-2 bg-indigo-800 items-center text-indigo-100 leading-none lg:rounded-full flex lg:inline-flex" role="alert">
+      <span class="flex rounded-full bg-indigo-500 uppercase px-2 py-1 text-xs font-bold mr-3">New</span>
+      <span class="font-semibold mr-2 text-left flex-auto">Get the coolest t-shirts from our brand new store</span>
+      <svg class="fill-current opacity-75 h-4 w-4" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"><path d="M12.95 10.707l.707-.707L8 4.343 6.586 5.757 10.828 10l-4.242 4.243L8 15.657l4.95-4.95z"/></svg>
+    </div>
+  </div>
+</template>
+
+<script>
+export default {
+
+}
+</script>
diff --git a/example/tailwind.config.js b/example/tailwind.config.js
@@ -0,0 +1,9 @@
+/*
+** TailwindCSS Configuration File
+** https://next.tailwindcss.com/docs/configuration
+*/
+module.exports = {
+  theme: {},
+  variants: {},
+  plugins: [],
+}
diff --git a/husky.config.js b/husky.config.js
@@ -0,0 +1,7 @@
+module.exports = {
+  hooks: {
+    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
+    'pre-commit': 'yarn lint',
+    'pre-push': 'yarn lint'
+  }
+}
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,17 @@
+module.exports = {
+  testEnvironment: 'node',
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'lib/**/*.js',
+    '!lib/plugin.js'
+  ],
+  moduleNameMapper: {
+    '^~/(.*)$': '<rootDir>/lib/$1',
+    '^~~$': '<rootDir>',
+    '^@@$': '<rootDir>',
+    '^@/(.*)$': '<rootDir>/lib/$1'
+  },
+  transform: {
+    '^.+\\.js$': 'babel-jest'
+  }
+}
diff --git a/lib/module.js b/lib/module.js
@@ -0,0 +1,39 @@
+import { resolve } from 'path'
+import ModuleUtils from './utils'
+
+export default async function (moduleOptions) {
+  // eslint-disable-next-line no-unused-vars
+  const options = {
+    ...this.options.tailwindcss,
+    ...moduleOptions
+  }
+  const { srcDir } = Object.assign({}, this.options)
+  const utils = new ModuleUtils(this.nuxt, __dirname)
+
+  /*
+  ** Generates if not exists:
+  ** - @/assets/css/tailwind.css
+  ** - tailwind.config.js
+  */
+  const tailwindCSSExists = await utils.ensureTemplateFile('./assets/css/tailwind.css')
+  // Include CSS file in project css
+  if (tailwindCSSExists) {
+    this.options.css.unshift('@/assets/css/tailwind.css')
+  }
+  await utils.ensureTemplateFile('./tailwind.config.js')
+
+  /*
+  ** Add nuxt-purgecss module and set config
+  */
+  const defaultPurgeCSS = { mode: 'postcss' }
+  const purgeCSS = Object.assign(defaultPurgeCSS, this.options.purgeCSS || {})
+  await this.requireModule(['nuxt-purgecss', purgeCSS])
+
+  /*
+  ** Set PostCSS config
+  */
+  this.options.build.postcss.plugins = this.options.build.postcss.plugins || {}
+  this.options.build.postcss.plugins.tailwindcss = this.options.build.postcss.plugins.tailwindcss || resolve(srcDir, 'tailwind.config.js')
+}
+
+module.exports.meta = require('../package.json')
diff --git a/lib/templates/assets/css/tailwind.css b/lib/templates/assets/css/tailwind.css
@@ -0,0 +1,3 @@
+@import 'tailwindcss/base';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';
diff --git a/lib/templates/tailwind.config.js b/lib/templates/tailwind.config.js
@@ -0,0 +1,9 @@
+/*
+** TailwindCSS Configuration File
+** https://next.tailwindcss.com/docs/configuration
+*/
+module.exports = {
+  theme: {},
+  variants: {},
+  plugins: []
+}
diff --git a/lib/utils.js b/lib/utils.js
@@ -0,0 +1,38 @@
+import { resolve } from 'path'
+import { pathExists, copy } from 'fs-extra'
+import consola from 'consola'
+
+const logger = consola.withScope('@nuxtjs/tailwindcss')
+
+class ModuleUtils {
+  constructor(nuxt, cwd) {
+    this.nuxt = nuxt
+    this.srcDir = nuxt.options.srcDir
+    this.cwd = cwd
+  }
+
+  resolveTemplate(path) {
+    return resolve(this.cwd, 'templates', path)
+  }
+
+  async ensureTemplateFile(path) {
+    const destPath = resolve(this.srcDir, path)
+    const relativePath = destPath.replace(this.srcDir, '~')
+    const fileExists = await pathExists(destPath)
+
+    if (fileExists) {
+      return true
+    }
+    try {
+      // Copy docs: https://github.com/jprichardson/node-fs-extra/blob/master/docs/copy.md
+      await copy(this.resolveTemplate(path), destPath)
+      logger.success(`${relativePath} created`)
+      return true
+    } catch (err) {
+      logger.warn(`Could not create ${relativePath}:`, err.message)
+      return false
+    }
+  }
+}
+
+export default ModuleUtils
diff --git a/package.json b/package.json
diff --git a/renovate.json b/renovate.json
diff --git a/test/module.test.js b/test/module.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@import 'tailwindcss/base';`
	`2`	`+@import 'tailwindcss/components';`
	`3`	`+@import 'tailwindcss/utilities';`