Skip to content

Commit

Permalink
refactor(cssnano-preset): migrate to TS (#7440)
Browse files Browse the repository at this point in the history
* refactor(cssnano-preset): migrate to TS

* fix
  • Loading branch information
Josh-Cena authored May 17, 2022
1 parent c8b5f23 commit 71b5901
Show file tree
Hide file tree
Showing 9 changed files with 76 additions and 43 deletions.
3 changes: 3 additions & 0 deletions packages/docusaurus-cssnano-preset/.npmignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
copyUntypedFiles.mjs
.tsbuildinfo*
tsconfig*
__tests__
25 changes: 0 additions & 25 deletions packages/docusaurus-cssnano-preset/index.js

This file was deleted.

9 changes: 7 additions & 2 deletions packages/docusaurus-cssnano-preset/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@
"name": "@docusaurus/cssnano-preset",
"version": "2.0.0-beta.20",
"description": "Advanced cssnano preset for maximum optimization.",
"main": "index.js",
"main": "lib/index.js",
"license": "MIT",
"publishConfig": {
"access": "public"
},
"scripts": {
"build": "tsc",
"watch": "tsc --watch"
},
"repository": {
"type": "git",
"url": "https://github.com/facebook/docusaurus.git",
Expand All @@ -15,7 +19,8 @@
"dependencies": {
"cssnano-preset-advanced": "^5.3.4",
"postcss": "^8.4.13",
"postcss-sort-media-queries": "^4.2.1"
"postcss-sort-media-queries": "^4.2.1",
"tslib": "^2.4.0"
},
"devDependencies": {
"to-vfile": "^6.1.0"
Expand Down
11 changes: 11 additions & 0 deletions packages/docusaurus-cssnano-preset/src/deps.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

declare module 'postcss-sort-media-queries' {
const plugin: import('postcss').PluginCreator<object>;
export default plugin;
}
27 changes: 27 additions & 0 deletions packages/docusaurus-cssnano-preset/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import advancedBasePreset from 'cssnano-preset-advanced';
import postCssSortMediaQueries from 'postcss-sort-media-queries';
import postCssRemoveOverriddenCustomProperties from './remove-overridden-custom-properties';

const preset: typeof advancedBasePreset = function preset(opts) {
const advancedPreset = advancedBasePreset({
autoprefixer: {add: false},
discardComments: {removeAll: true},
...opts,
});

advancedPreset.plugins.unshift(
[postCssSortMediaQueries, undefined],
[postCssRemoveOverriddenCustomProperties, undefined],
);

return advancedPreset;
};

export = preset;
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
* LICENSE file in the root directory of this source tree.
*/

const path = require('path');
const vfile = require('to-vfile');
const postcss = require('postcss');
const postCssRemoveOverriddenCustomProperties = require('../index');
import path from 'path';
import vfile from 'to-vfile';
import postcss from 'postcss';
import postCssRemoveOverriddenCustomProperties from '../index';

const processFixture = (name) => {
const processFixture = (name: string) => {
const input = vfile.readSync(
path.join(__dirname, '__fixtures__', `${name}.css`),
'utf8',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
* LICENSE file in the root directory of this source tree.
*/

import type {Plugin, Rule, Node} from 'postcss';

const isRule = (node: Node | undefined): node is Rule => node?.type === 'rule';

/**
* This PostCSS plugin will remove duplicate/same custom properties (which are
* actually overridden ones) **only** from `:root` selector.
Expand All @@ -17,32 +21,31 @@
* applied).
* - If the same custom properties have at least one `!important` rule, then
* only those properties that do not have this rule will be removed.
* @returns {import('postcss').Plugin}
*/
module.exports = function creator() {
function creator(): Plugin {
return {
postcssPlugin: 'postcss-remove-overridden-custom-properties',
Declaration(decl) {
if (decl.parent.selector !== ':root') {
if (!isRule(decl.parent) || decl.parent.selector !== ':root') {
return;
}

const sameProperties = decl.parent.nodes.filter(
(n) => n.prop === decl.prop,
(n) => 'prop' in n && n.prop === decl.prop,
);
const hasImportantProperties = sameProperties.some((p) =>
Object.prototype.hasOwnProperty.call(p, 'important'),
const hasImportantProperties = sameProperties.some(
(p) => 'important' in p,
);

const overriddenProperties = hasImportantProperties
? sameProperties.filter(
(p) => !Object.prototype.hasOwnProperty.call(p, 'important'),
)
? sameProperties.filter((p) => !('important' in p))
: sameProperties.slice(0, -1);

overriddenProperties.map((p) => p.remove());
},
};
};
}

creator.postcss = true as const;

module.exports.postcss = true;
export default creator;
9 changes: 9 additions & 0 deletions packages/docusaurus-cssnano-preset/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"incremental": true,
"tsBuildInfoFile": "./lib/.tsbuildinfo",
"rootDir": "src",
"outDir": "lib"
}
}

0 comments on commit 71b5901

Please sign in to comment.