Skip to content

Feature/multiple modifier values #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bgilhome-lds wants to merge 2 commits into
base: release/2.0.0
Choose a base branch
from
Open

Feature/multiple modifier values #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
210ef07
Handle multiple modifier values (pipe-delimited) and names (comma-sep…
Jun 12, 2023
07f5600
Handle multiple element names (comma-separated, like CSS selectors).
Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ postcss([bike()]).process(css).then((res) => console.log(output.css));
}
}

@mod theme[foo|bar] {
@elem header {
position: absolute;
}
}

@elem header {
flex: 0 0 50px;
background-color: #fff;
Expand Down Expand Up @@ -90,6 +96,10 @@ Transformed to:
background-color: #1b1b1b;
color: #fff;
}
.example_theme_foo .example__header,
.example_theme_bar .example__header {
position: absolute;
}
.example__header {
flex: 0 0 50px;
background-color: #fff;
Expand Down Expand Up @@ -134,10 +144,11 @@ Allows to set custom name for modifier `@rule`.
### `modifierRegExp`

type: `RegExp`
default: `{modifierRegExp: /(\w+)\[(\w+)\]/}`
default: `{modifierRegExp: /(\w+)\[(\w+)| \]/}`

Allows to set custom regular expressions for modifier params. Where `$1` is Modifier Name and `$2` is Modifier Value. For
changing Modifier Value Separator, change default separator `\[$2\]`, which goes before and after `$2` (only this `[ ]` symbols).
Multiple values (used as 'OR') can be separated with a vertical pipe (`|`).


### License [MIT](LICENSE)
Expand Down
23 changes: 15 additions & 8 deletions src/bem.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,29 @@ export const BEM = (block) => (elem, mods) => {
return base;
}

// Handle multiple bases e.g. comma-separated elements.
let bases = [base];

if (typeof elem === 'object') {
mods = elem;
elem = '';
}

if (elem !== '') {
base = `.${block}__${elem}`;
bases = elem.split(',').map(elem => {
return `.${block}__${elem.trim()}`;
});
}

return (mods ? Object.entries(mods).reduce((target, [key, value]) => {
if (!value) {
return target;
}
return bases.map(base => {
return mods ? Object.entries(mods).reduce((target, [key, value]) => {
if (!value) {
return target;
}

target += `${value === true ? (`${base}_${key}`) : (`${base}_${key}_${value}`)}`;
target += `${value === true ? (`${base}_${key}`) : (`${base}_${key}_${value}`)}`;

return target;
}, '') : base);
return target;
}, '') : base;
}).join(', ');
};
67 changes: 38 additions & 29 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const DEFAULT_OPTIONS = {
component: 'component',
element: 'elem',
modifier: 'mod',
modifierRegExp: /([\w\-]+)(?:\[([\w\-]+)\])?/
modifierRegExp: /([\w\-]+)(?:\[([\w\-| ]+)\])?/
};

export default postcss.plugin('postcss-bike', (options = DEFAULT_OPTIONS) => {
Expand All @@ -21,37 +21,46 @@ export default postcss.plugin('postcss-bike', (options = DEFAULT_OPTIONS) => {
node.metadata = { bem: BEM(node.params), type: options.component };
}

let selector = '';

switch (node.metadata.type) {
case options.component:
selector = node.metadata.bem();
break;
case options.modifier:
let [, modName, modVal = true] = node.metadata.name.match(options.modifierRegExp);

node.metadata.mods = { [modName]: modVal };

if (node.parent.metadata.type === options.element) {
selector = node.metadata.bem(node.parent.metadata.name, { [modName]: modVal });
} else if (node.parent.metadata.type === options.modifier) {
selector = node.metadata.bem({ ...node.parent.metadata.mods, [modName]: modVal });
} else {
selector = node.metadata.bem({ [modName]: modVal });
}
break;
case options.element:
if (node.parent.metadata.type === options.modifier) {
selector = [node.parent.selector, node.metadata.bem(node.metadata.name)].join(' ');
} else {
selector = node.metadata.bem(node.metadata.name);
}
break;
}
let selectors = [];

node.metadata.names = node.metadata.name ? node.metadata.name.split(',').map(val => val.trim()) : [''];
node.metadata.names.forEach(metaName => {
switch (node.metadata.type) {
case options.component:
selectors.push(node.metadata.bem());
break;
case options.modifier:
let [, modName, modVals = true] = metaName.match(options.modifierRegExp);

// Handle possible multiple comma-delimited modifier values.
modVals = typeof modVals === 'string' ? modVals.split('|').map(val => val.trim()) : [modVals];
modVals.forEach(modVal => {
node.metadata.mods = { [modName]: modVal };

if (node.parent.metadata.type === options.element) {
selectors.push(node.metadata.bem(node.parent.metadata.name, { [modName]: modVal }));
} else if (node.parent.metadata.type === options.modifier) {
selectors.push(node.metadata.bem({ ...node.parent.metadata.mods, [modName]: modVal }));
} else {
selectors.push(node.metadata.bem({ [modName]: modVal }));
}
});
break;
case options.element:
if (node.parent.metadata.type === options.modifier) {
node.parent.selectors.forEach(parentSelector => {
selectors.push([parentSelector, node.metadata.bem(metaName)].join(' '));
});
} else {
selectors.push(node.metadata.bem(metaName));
}
break;
}
});

const rule = postcss.rule({
raws: { semicolon: true },
selector: selector,
selectors: selectors,
source: node.source,
metadata: node.metadata
});
Expand Down