{"id":20247312,"url":"https://github.com/tbremer/postcss-atrule-bem","last_synced_at":"2025-04-10T21:32:08.945Z","repository":{"id":12193939,"uuid":"70772643","full_name":"tbremer/postcss-atrule-bem","owner":"tbremer","description":"CSS At Rules for writing semantic BEM components.","archived":false,"fork":false,"pushed_at":"2022-12-03T12:28:37.000Z","size":325,"stargazers_count":11,"open_issues_count":7,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-21T06:34:57.599Z","etag":null,"topics":["bem","css","frontend","postcss"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tbremer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-13T05:39:18.000Z","updated_at":"2023-07-29T03:28:16.000Z","dependencies_parsed_at":"2023-01-13T16:49:39.837Z","dependency_job_id":null,"html_url":"https://github.com/tbremer/postcss-atrule-bem","commit_stats":null,"previous_names":["tbremer/postcss-bem-atrule"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbremer%2Fpostcss-atrule-bem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbremer%2Fpostcss-atrule-bem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbremer%2Fpostcss-atrule-bem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tbremer%2Fpostcss-atrule-bem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tbremer","download_url":"https://codeload.github.com/tbremer/postcss-atrule-bem/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248301411,"owners_count":21080892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bem","css","frontend","postcss"],"created_at":"2024-11-14T09:36:46.513Z","updated_at":"2025-04-10T21:32:08.926Z","avatar_url":"https://github.com/tbremer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"atrule-bem\n---\n[![Travis](https://img.shields.io/travis/tbremer/postcss-atrule-bem.svg?style=flat-square)](https://travis-ci.org/tbremer/postcss-atrule-bem)\n[![npm](https://img.shields.io/npm/v/postcss-atrule-bem.svg?style=flat-square)](https://www.npmjs.com/package/postcss-atrule-bem)\n[![npm](https://img.shields.io/npm/l/postcss-atrule-bem.svg?style=flat-square)](https://github.com/tbremer/postcss-atrule-bem/blob/master/LICENSE)\n\n_Efficiently create BEM components._\n\n## Input / Output\n### Put in:\n```css\n@block btn {\n  background-color: var(--primary);\n  border: .0625rem solid var(--primary-constrast);\n  color: var(--black);\n\n  @element icon {\n    color: var(--primary-contrast-high)\n  }\n\n  @modifier transparent {\n    background-color: transparent;\n    border-color: transparent\n  }\n}\n```\n\n### Get out:\n```css\n.btn {\n    background-color: var(--primary);\n    border: .0625rem solid var(--primary-constrast);\n    color: var(--black)\n}\n.btn__icon {\n    color: var(--primary-contrast-high)\n}\n.btn--transparent {\n    background-color: transparent;\n    border-color: transparent\n}\n```\n\n## Options\n\n#### `strict`\n\nType: `Boolean`\n\nDefault: `true`\n\n**Disallows improperly formed components**\n- Block's can only have: Elements and Modifiers.\n- Elements can only have Modifiers.\n- Modifiers cannot house any types.\n\n_**Side Effect:** turning off `strict` turns off warnings_\n\n#### `warn`\n\nType: `Boolean`\n\nDefault: `true`\n\n**Turns on warnings for imporperly formed components**\n\n#### `shortcuts`\n\nType: `Boolean`\n\nDefault: `false`\n\n#### `separators`\n\nType: `Object`\n\nDefault: `{\n    element: '__',\n    modifier: '--'\n  }`\n\n## Usage\n\nAdd *atrule-bem* to your build tool:\n\n```bash\nnpm install --save-dev postcss-atrule-bem\n```\n\n#### Node\n\n```js\nimport atRuleBem from 'postcss-atrule-bem';\n\natRuleBem.process(/* your css */);\n```\n\n#### PostCSS\n\nAdd *PostCSS* to your build tool:\n\n```bash\nnpm install postcss --save-dev\n```\n\nLoad *atrule-bem* as a PostCSS plugin:\n\n```js\nimport atRuleBem from 'postcss-atrule-bem';\n\npostcss([ atRuleBem() ])\n.process(/* your css */, /* options */);\n```\n\n### Examples\n```css\n/* you can chain selectors with commas `,` */\n\n/* input: */\n@block foo {\n  @element bar, baz {}\n}\n\n/* output: */\n.foo {}\n.foo__bar, .foo__baz {}\n```\n\n### Pull requests welcome.\n\nOpen for pull requests in the following areas:\n\n- Collision detection\n  - throw a warning and don't compile when:\n    - a block is created twice (name collisions)\n    - a block makes reference to another block\n\n## Updating 3.0 for CommonJS users.\nI added a babel plugin to correctly adapt the default export to the expected CommonJS type.\n\nTo upgrade change `const atRuleBem = require('postcss-atrule-bem').default;` to `const atRuleBem = require('postcss-atrule-bem');`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbremer%2Fpostcss-atrule-bem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftbremer%2Fpostcss-atrule-bem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftbremer%2Fpostcss-atrule-bem/lists"}