Skip to content

Commit 7090081

Browse files
author
张宁宁
committed
chore: 🎉 init
1 parent 9f3963e commit 7090081

11 files changed

+293
-14
lines changed

‎.editorconfig

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = crlf
7+
charset = utf-8
8+
trim_trailing_whitespace = false
9+
insert_final_newline = false

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
package-lock.json

‎.npmignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
package-lock.json
3+
.*

‎.travis.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
language: node_js
2+
3+
node_js:
4+
- stable
5+
- "6"
6+
7+
install:
8+
- npm install

‎.vscode/launch.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"name": "Debug Jest Tests",
6+
"type": "node",
7+
"request": "launch",
8+
"runtimeArgs": [
9+
"--inspect-brk",
10+
"${workspaceRoot}/node_modules/.bin/jest",
11+
"--runInBand"
12+
],
13+
"console": "integratedTerminal",
14+
"internalConsoleOptions": "neverOpen",
15+
}
16+
]
17+
}

‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Changelog
2+
3+
## 1.0.0 - 2022-07-16
4+
* Initial release

‎LICENSE

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
MIT License
1+
The MIT License (MIT)
22

3-
Copyright (c) 2022 cherry-man
3+
Copyright 2022 flyflydogdog <[email protected]>
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# PostCSS CSS var to Less var [<img src="https://postcss.github.io/postcss/logo.svg" alt="PostCSS Logo" width="90" height="90" align="right">](https://github.com/postcss/postcss)
2+
[![NPM Version](https://img.shields.io/npm/v/postcss-transform-css-var.svg)](https://www.npmjs.com/package/postcss-transform-css-var)
3+
[![BGitter Chat](https://img.shields.io/badge/chat-gitter-blue.svg)](https://gitter.im/postcss/postcss)
4+
5+
A [PostCSS](https://github.com/postcss/postcss) plugin to convert CSS variables to Less variables
6+
7+
## Installation
8+
```
9+
npm install postcss-transform-css-var
10+
```
11+
12+
## Examples
13+
```css
14+
/* input css/less */
15+
:root { --color: black; }
16+
@prefix: ~'flyfly';
17+
.@prefix {
18+
&-foo {
19+
--color: red;
20+
// --c: 10px;
21+
&-bar {
22+
background: var(--color, blue);
23+
}
24+
}
25+
}
26+
```
27+
```less
28+
/* output less */
29+
@color: black;
30+
@prefix: ~'flyfly';
31+
.@prefix {
32+
&-foo {
33+
@color: red;
34+
// --c: 10px;
35+
&-bar {
36+
background: @color;
37+
}
38+
}
39+
}
40+
```
41+
42+
## Usage
43+
44+
### [Postcss JS API](https://github.com/postcss/postcss#js-api)
45+
```js
46+
postcss([require('postcss-transform-css-var')]).process(yourCSS);
47+
```
48+
49+
### [Gulp](https://github.com/gulpjs/gulp)
50+
```js
51+
const gulp = require('gulp');
52+
const postcss = require('gulp-postcss');
53+
const syntax = require('postcss-less');
54+
const varConvert = require('postcss-transform-css-var');
55+
const through = require("through2");
56+
57+
const convertPipe = () =>
58+
through.obj(async(file, enc, cb) => {
59+
let result = await postcss([varConvert()]).process(file.contents, {
60+
from: undefined,
61+
syntax: syntax
62+
});
63+
file.contents = Buffer.from(result.css, enc);
64+
cb(null, file);
65+
})
66+
67+
gulp.src('src/**/*.less', { basePath: './' })
68+
.pipe(convertPipe())
69+
.pipe(gulp.dest('./', { overwrite: true }))
70+
```
71+
72+
## Tests
73+
```
74+
npm test
75+
```
76+
77+
## TODO
78+
- [ ] support option `type: scss`
79+
80+
## Special thanks
81+
This package is a fork of [postcss-css-var-to-less-var](https://github.com/lauthieb/postcss-css-var-to-less-var). Thanks a lot [lauthieb](https://github.com/lauthieb) for this great work!
82+
83+
## License
84+
This project is licensed under the [MIT License](./LICENSE).

‎index.js

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/**
2+
* @type {import('postcss').PluginCreator}
3+
*/
4+
const util = require("postcss-plugin-utilities");
5+
6+
function varToLess(_, variable) {
7+
return "@" + variable.substring(2);
8+
}
9+
10+
module.exports = (opts = {}) => {
11+
// Work with options here
12+
13+
return {
14+
postcssPlugin: "postcss-transform-css-var",
15+
Root(root, postcss) {
16+
// Transform CSS AST here
17+
root.walkRules(":root", (rule) => {
18+
rule.walkDecls((decl) => {
19+
rule.before(decl);
20+
});
21+
rule.remove();
22+
});
23+
root.walkDecls((decl) => {
24+
if (decl.prop.startsWith("--"))
25+
decl.prop = "@" + decl.prop.substring(2);
26+
});
27+
util.parseFunction(root, "var", varToLess);
28+
},
29+
30+
/*
31+
Declaration (decl, postcss) {
32+
// The faster way to find Declaration node
33+
}
34+
*/
35+
36+
/*
37+
Declaration: {
38+
color: (decl, postcss) {
39+
// The fastest way find Declaration node if you know property name
40+
}
41+
}
42+
*/
43+
};
44+
};
45+
46+
module.exports.postcss = true;
47+

‎index.test.js

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
const postcss = require("postcss");
2+
const syntaxLess = require("postcss-less");
3+
const plugin = require("./");
4+
5+
async function run(input, output, opts = {}) {
6+
let result = await postcss([plugin(opts)]).process(input, {
7+
from: undefined,
8+
syntax: syntaxLess
9+
});
10+
expect(result.css).toEqual(output);
11+
expect(result.warnings()).toHaveLength(0);
12+
}
13+
14+
it("can convert variables in css", async () => {
15+
await run(
16+
":root { --color: black; --size: 15px; } div { --size: 20px; background: var(--color); font-size: var(--size) } p { font-size: var(--size) }",
17+
" @color: black; @size: 15px; div { @size: 20px; background: @color; font-size: @size } p { font-size: @size }",
18+
{}
19+
);
20+
});
21+
22+
it("can convert variables in less", async () => {
23+
await run(
24+
`:root { --color: black; }
25+
@prefix: ~'flyfly';
26+
.@prefix {
27+
&-foo {
28+
--color: red;
29+
// --c: 10px;
30+
&-bar {
31+
background: var(--color, blue);
32+
}
33+
}
34+
}
35+
`,
36+
` @color: black;
37+
@prefix: ~'flyfly';
38+
.@prefix {
39+
&-foo {
40+
@color: red;
41+
// --c: 10px;
42+
&-bar {
43+
background: @color;
44+
}
45+
}
46+
}
47+
`,
48+
{}
49+
);
50+
});
51+

‎package.json

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "postcss-transform-css-var",
3+
"version": "1.0.0",
4+
"description": "A PostCSS plugin to convert CSS variables to Less variables",
5+
"main": "index.js",
6+
"license": "MIT",
7+
"repository": "https://github.com/luckymore/postcss-transform-css-var.git",
8+
"homepage": "https://github.com/luckymore/postcss-transform-css-var#readme",
9+
"bugs": "https://github.com/luckymore/postcss-transform-css-var/issues",
10+
"keywords": [
11+
"postcss",
12+
"postcss-plugin",
13+
"preprocessor",
14+
"plugin",
15+
"css",
16+
"style",
17+
"variable",
18+
"less"
19+
],
20+
"author": "luckymore <[email protected]>",
21+
"contributors": [
22+
"luckymore <[email protected]>"
23+
],
24+
"maintainers": [
25+
"luckymore <[email protected]>"
26+
],
27+
"engines": {
28+
"node": ">=6.0.0"
29+
},
30+
"scripts": {
31+
"test": "jest"
32+
},
33+
"eslintConfig": {
34+
"extends": "standard",
35+
"env": {
36+
"es6": true,
37+
"jest": true
38+
}
39+
},
40+
"jest": {
41+
"verbose": true,
42+
"testURL": "http://localhost/"
43+
},
44+
"dependencies": {
45+
"postcss": "^8.4.14",
46+
"postcss-less": "^6.0.0",
47+
"postcss-plugin-utilities": "^2.2.9"
48+
},
49+
"devDependencies": {
50+
"babel-eslint": "^8.2.2",
51+
"eslint": "^4.18.2",
52+
"eslint-config-postcss": "^2.0.2",
53+
"jest": "^22.4.2"
54+
}
55+
}

0 commit comments

Comments
 (0)