][PostCSS]
-[![NPM Version][npm-img]][npm-url]
-[![Build Status][cli-img]][cli-url]
-[![Gitter Chat][git-img]][git-url]
+[
][npm-url]
+[
][cli-url]
+[
][git-url]
[PostCSS Tape] lets you quickly test [PostCSS] plugins.
@@ -22,7 +22,7 @@
3. Add tests to your `.tape.js` file:
```js
- module.exports = {
+ export default {
'basic': {
message: 'supports basic usage'
}
@@ -310,11 +310,8 @@ postcss-tape --fixtures path/to/tests
}
```
-[npm-img]: https://img.shields.io/npm/v/postcss-tape.svg
[npm-url]: https://www.npmjs.com/package/postcss-tape
-[cli-img]: https://img.shields.io/travis/csstools/postcss-tape/master.svg
[cli-url]: https://travis-ci.org/csstools/postcss-tape
-[git-img]: https://img.shields.io/badge/chat-gitter-blue.svg
[git-url]: https://gitter.im/postcss/postcss
[PostCSS]: https://github.com/postcss/postcss
diff --git a/package.json b/package.json
index 84f94d7..367740c 100644
--- a/package.json
+++ b/package.json
@@ -1,20 +1,20 @@
{
"name": "postcss-tape",
- "version": "5.0.2",
"description": "Quickly test PostCSS plugins",
+ "version": "5.0.2",
+ "type": "commonjs",
+ "main": "./dist/index.js",
+ "bin": {
+ "postcss-tape": "./dist/index.js"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/csstools/postcss-tape.git"
+ },
"author": "Jonathan Neal ][PostCSS]
[][npm-url]
-[][cli-url]
+[
][cli-url]
[][git-url]
[PostCSS Tape] lets you quickly test [PostCSS] plugins.
diff --git a/package.json b/package.json
index 3f77ff3..ce274e5 100644
--- a/package.json
+++ b/package.json
@@ -27,7 +27,7 @@
"test:tape:ci": "npm run test:tape:7 -- --ci true && npm run test:tape:8 -- --ci true"
},
"engines": {
- "node": "^10 || ^12 || ^14"
+ "node": ">=10.0.0"
},
"peerDependencies": {
"postcss": "^7 || ^8"
diff --git a/src/index.js b/src/index.js
index 7a0fdeb..ef868a5 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,12 +1,13 @@
-import { exitFail, exitPass } from './lib/exit'
-import { readOrWriteFile, safelyReadFile, writeFile } from './lib/utils'
-import * as log from './lib/log'
-import getErrorMessage from './lib/get-error-message'
-import getOptions from './lib/get-options'
+import * as exit from './lib/exit.js'
+import { readOrWriteFile, safelyReadFile, writeFile } from './lib/utils.js'
+import { getErrorMessage } from './lib/get-error-message.js'
+import { getOptions } from './lib/get-options.js'
+import * as log from './lib/log.js'
import path from 'path'
-async function postcss8(plugins) {
+const postcss8 = async (plugins) => {
const pkg = await import('postcss/package.json')
+
if (pkg.version[0] === '8') {
const m = await import('postcss')
return m.default(plugins)
@@ -15,9 +16,7 @@ async function postcss8(plugins) {
}
}
-function isPostcss8Plugin(plugin) {
- return typeof plugin === 'function' && Object(plugin).postcss === true
-}
+const isPostcss8Plugin = (plugin) => typeof plugin === 'function' && Object(plugin).postcss === true
getOptions().then(
async options => {
@@ -39,9 +38,11 @@ getOptions().then(
const pluginOptions = test.options
let rawPlugin = test.plugin || options.plugin
+
if (rawPlugin.default) {
rawPlugin = rawPlugin.default
}
+
const plugin = isPostcss8Plugin(rawPlugin)
? rawPlugin(pluginOptions)
: typeof Object(rawPlugin).process === 'function'
@@ -63,12 +64,15 @@ getOptions().then(
const sourceCSS = await readOrWriteFile(sourcePath, expectCSS)
let result
+
if (isPostcss8Plugin(rawPlugin)) {
const postcss = await postcss8([ plugin ])
+
result = await postcss.process(sourceCSS, processOptions)
} else {
result = await plugin.process(sourceCSS, processOptions, pluginOptions)
}
+
const resultCSS = result.css
if (options.fix) {
@@ -168,6 +172,5 @@ getOptions().then(
throw hadError
}
}
-).then(exitPass, exitFail)
-
+).then(exit.pass, exit.fail)
diff --git a/src/lib/color.js b/src/lib/color.js
index dadf489..17095c9 100644
--- a/src/lib/color.js
+++ b/src/lib/color.js
@@ -1,3 +1,4 @@
+/** Color keys. */
const colors = {
reset: '\x1b[0m',
bold: '\x1b[1m',
@@ -24,6 +25,9 @@ const colors = {
bgWhite: '\x1b[47m'
}
-export default function color (name, string) {
- return colors[name] + string.replace(colors.reset, colors.reset + colors[name]) + colors.reset
-}
+/** Return a string wrapped in a CLI color. */
+export const color = (/** @type {keyof colors} */ name, /** @type {string} */ string) => (
+ colors[name] +
+ string.replace(colors.reset, colors.reset + colors[name]) +
+ colors.reset
+)
diff --git a/src/lib/exit.js b/src/lib/exit.js
index 69556f2..57cb124 100644
--- a/src/lib/exit.js
+++ b/src/lib/exit.js
@@ -1,9 +1,11 @@
-export function exitFail (error) {
+/** Exit the process logging an error and with a failing exit code. */
+export const fail = (error) => {
console.log(error)
process.exit(1)
}
-export function exitPass () {
+/** Exit the process with a passing exit code. */
+export const pass = () => {
process.exit(0)
}
diff --git a/src/lib/get-error-message.js b/src/lib/get-error-message.js
index abce20e..f66c8ca 100644
--- a/src/lib/get-error-message.js
+++ b/src/lib/get-error-message.js
@@ -1,3 +1,4 @@
-export default function getErrorMessage (error) {
- return Object(error).message || error
-}
+/** Return the error message. */
+export const getErrorMessage = (/** @type {Error | string} */ error) => String(
+ Object(error).message || error
+)
diff --git a/src/lib/get-options-from-arguments.js b/src/lib/get-options-from-arguments.js
index 21bbdee..51189cb 100644
--- a/src/lib/get-options-from-arguments.js
+++ b/src/lib/get-options-from-arguments.js
@@ -3,31 +3,30 @@ const primativeRegExp = /^(false|null|true|undefined|(\d+\.)?\d+|\{.*\}|\[.*\])$
const relaxedJsonPropRegExp = /(['"])?([a-z0-9A-Z_]+)\1:/g
const relaxedJsonValueRegExp = /("[a-z0-9A-Z_]+":\s*)(?!true|false|null|\d+)'?([A-z0-9]+)'?([,}])/g
-export default function getOptionsFromArguments (defaultOptions) {
- return process.argv.slice(2).reduce(
- (args, arg, index, argv) => {
- const nextIndex = index + 1
- const nextArg = argv[nextIndex]
- const argMatch = arg.match(argRegExp)
+/** Return an object of options from a CLI array of arguments. */
+export const getOptionsFromArguments = (/** @type {object} */ defaultOptions) => process.argv.slice(2).reduce(
+ (/** @type {object} */ args, /** @type {string} */ arg, /** @type {number} */ index, /** @type {object} */ argv) => {
+ const nextIndex = index + 1
+ const nextArg = argv[nextIndex]
+ const argMatch = arg.match(argRegExp)
- if (argMatch) {
- const [, name] = argMatch
+ if (argMatch) {
+ const [, name] = argMatch
- if (!nextArg || argRegExp.test(nextArg)) {
- args[name] = true
- } else {
- args[name] = primativeRegExp.test(nextArg)
- ? JSON.parse(
- nextArg
- .replace(relaxedJsonPropRegExp, '"$2": ')
- .replace(relaxedJsonValueRegExp, '$1"$2"$3')
- )
- : nextArg
- }
+ if (!nextArg || argRegExp.test(nextArg)) {
+ args[name] = true
+ } else {
+ args[name] = primativeRegExp.test(nextArg)
+ ? JSON.parse(
+ nextArg
+ .replace(relaxedJsonPropRegExp, '"$2": ')
+ .replace(relaxedJsonValueRegExp, '$1"$2"$3')
+ )
+ : nextArg
}
+ }
- return args
- },
- Object.assign({}, defaultOptions)
- )
-}
+ return args
+ },
+ Object.assign({}, defaultOptions)
+)
diff --git a/src/lib/get-options.js b/src/lib/get-options.js
index 39faed0..2c5c8da 100644
--- a/src/lib/get-options.js
+++ b/src/lib/get-options.js
@@ -1,8 +1,9 @@
-import getOptionsFromArguments from './get-options-from-arguments'
-import { readJSON } from './utils'
+import { getOptionsFromArguments } from './get-options-from-arguments.js'
+import { readJSON } from './utils.js'
import path from 'path'
-export default async function getOptions() {
+/** Asynchronously return the options from the project. */
+export const getOptions = async () => {
const cwd = process.cwd()
// default options
@@ -34,6 +35,7 @@ export default async function getOptions() {
'.tape.mjs',
'.tape.cjs'
]
+
let returnError
while (postcssTapeConfigFiles.length) {
diff --git a/src/lib/log.js b/src/lib/log.js
index d8cc637..8a11098 100644
--- a/src/lib/log.js
+++ b/src/lib/log.js
@@ -1,4 +1,4 @@
-import color from './color'
+import { color } from './color.js'
import readline from 'readline'
// symbols
@@ -9,7 +9,8 @@ const stdout = process.stdout
let interval
-export function pass (name, message, ci) {
+/** Log as a passing state. */
+export const pass = (/** @type {string} */ name, /** @type {string} */ message, /** @type {boolean} */ ci) => {
clearInterval(interval)
if (ci) {
@@ -23,7 +24,8 @@ export function pass (name, message, ci) {
}
}
-export function fail (name, message, details, ci) {
+/** Log as a failing state. */
+export const fail = (/** @type {string} */ name, /** @type {string} */ message, /** @type {string} */ details, /** @type {boolean} */ ci) => {
clearInterval(interval)
if (ci) {
@@ -37,8 +39,8 @@ export function fail (name, message, details, ci) {
}
}
-// log with a waiting appearance
-export function wait (name, message, ci) {
+/** Log as a waiting state. */
+export const wait = (/** @type {string} */ name, /** @type {string} */ message, /** @type {boolean} */ ci) => {
if (ci) {
stdout.write(`${name} ${color('dim', message)}`)
} else {
diff --git a/src/lib/utils.js b/src/lib/utils.js
index b0bfffe..9f6c7b4 100644
--- a/src/lib/utils.js
+++ b/src/lib/utils.js
@@ -1,7 +1,8 @@
import fs from 'fs'
-export function readFile (pathname) {
- return new Promise((resolve, reject) => {
+/** Reads a file and returns its string content */
+export const readFile = (/** @type {string} */ pathname) => /** @type {Promise⚠️ PostCSS Tape is deprecated in favor of @csstools/postcss-tape. ⚠️
+
# PostCSS Tape [][PostCSS]
[][npm-url]