{"id":16346613,"url":"https://github.com/matype/scssfmt","last_synced_at":"2025-03-20T23:32:48.564Z","repository":{"id":57377111,"uuid":"91337371","full_name":"matype/scssfmt","owner":"matype","description":"Standard SCSS code formatter","archived":false,"fork":false,"pushed_at":"2019-01-08T03:48:47.000Z","size":1586,"stargazers_count":57,"open_issues_count":3,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T18:53:50.521Z","etag":null,"topics":["beautifier","css","formatter","sass","scss"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matype.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":"2017-05-15T12:51:09.000Z","updated_at":"2022-09-04T10:45:15.000Z","dependencies_parsed_at":"2022-09-26T16:41:43.593Z","dependency_job_id":null,"html_url":"https://github.com/matype/scssfmt","commit_stats":null,"previous_names":["morishitter/scssfmt","morishitter/tidify","matype/scssfmt"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matype%2Fscssfmt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matype%2Fscssfmt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matype%2Fscssfmt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matype%2Fscssfmt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matype","download_url":"https://codeload.github.com/matype/scssfmt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244541793,"owners_count":20469240,"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":["beautifier","css","formatter","sass","scss"],"created_at":"2024-10-11T00:35:46.623Z","updated_at":"2025-03-20T23:32:48.213Z","avatar_url":"https://github.com/matype.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e Standard SCSS code formatter\n\n\u003cdiv align=\"center\" style=\"margin:30px 0\"\u003e\n  \u003ca href=\"https://github.com/morishitter/scssfmt\"\u003e\n    \u003cimg width=360px src=\"http://scssfmt.com/logo.svg\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/morishitter/scssfmt\"\u003e\n    \u003cimg src=\"https://camo.githubusercontent.com/e688e140da51d197ac1230acf711eb12f85f70be/68747470733a2f2f7472617669732d63692e6f72672f6d6f7269736869747465722f73637373666d742e737667\" alt=\"Build Status\" data-canonical-src=\"https://travis-ci.org/morishitter/scssfmt.svg\" style=\"max-width:100%;\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/scssfmt\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/scssfmt.svg?style=flat-square\" alt=\"NPM Version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://david-dm.org/morishitter/scssfmt\"\u003e\n    \u003cimg src=\"https://david-dm.org/morishitter/scssfmt.svg\"\n        alt=\"Dependency Status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-444444.svg?style=flat-square\"\n        alt=\"License\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Installation\n\n```\n$ npm install scssfmt\n```\n\nInstall to global (If you install scssfmt global, you can use it easily in CLI):\n\n```\n$ npm install -g scssfmt\n```\n\n## Usage\n\n### in Command Line\n\nSimple usage:\n\n```\n$ scssfmt input.css output.css\n```\n\n#### `--watch`\n\nWatch one file:\n\n```\n$ scssfmt --watch input.css\n```\n\nWatch multiple files by glob:\n\n```\n$ scssfmt --watch 'app/assets/stylesheets/**/*.scss'\n```\n\nwith `--ignore` option:\n\n```\n$ scssfmt --watch 'app/assets/stylesheets/**/*.scss' --ignore app/assets/stylesheets/ignore.css\n```\n\nalso can use specify multiple files by glob:\n\n```\n$ scssfmt --watch 'app/assets/stylesheets/**/*.scss' --ignore 'app/assets/stylesheets/ignore/**/*'\n```\n\n#### `--recursive`\n\nFormat multiple files by glob:\n\n```\n$ scssfmt --recursive 'app/assets/stylesheets/**/*.scss'\n```\n\n#### `--diff`\n\nShow diff (don't change code):\n\n```\n$ scssfmt input.css --diff\n```\n\n#### `--help`\n\nCLI help:\n\n```\n$ scssfmt --help\n```\n\n```\nUsage: scssfmt [options] input-name [output-name]\n\nOptions:\n\n  -w, --watch            Watch directories or files\n  -d, --diff             Output diff against original file\n  -r, --recursive        Format list of space seperated files(globs) in place\n  -v, --version          Output the version number\n  -h, --help             Output usage information\n  --stdin-filename       A filename to assign stdin input.\n```\n\n#### Use stdin as inputs\n\nscssfmt can also read a file from stdin if there are no input-file as argument in CLI.\n\n```\n$ cat input.css | scssfmt --stdin-filename input.css\n```\n\n### Node.js\n\n```js\nconst fs = require('fs')\nconst scssfmt = require('scssfmt')\n\nconst css = fs.readFileSync('example.css', 'utf-8')\nconst formatted = scssfmt(css)\n```\n\n### PostCSS plugin\n\n```js\nconst fs = require('fs')\nconst scssfmt = require('scssfmt')\n\nconst css = fs.readFileSync('example.css', 'utf-8')\npostcss([scssfmt.plugin()])\n  .process(css, {syntax: scss})\n  .then(result =\u003e {\n    const formatted = result.css\n  })\n```\n\n## Rules for formatting\n\n- 2 spaces indentation\n- require 1 space between a simple selector and combinator\n- require new line between selectors\n- require 1 space between selectors and `{`\n- require new line after `{`\n- disallow any spaces between property and `:`\n- require 1 space between `:` and values\n- require a new line after declarations at least\n- require `;` in last declaration\n- require 1 space between values and `!important`\n- Do not format any spaces between rules\n- Do not format any spaces between a rule and a comment\n- require 1 space between a value and `!important`\n- require 1 space between `@mixin` and mixin name\n- require 1 space between mixin name and `(`\n- require 1 space between `@extend` and base rules\n- require 1 space between `@include` and mixin name\n- disallow any spaces between `$variable` and `:`\n- require 1 space between `:` and name of variable\n- Do not format any spaces before `@else`\n\n## Examples\n\nSee [tests](https://github.com/morishitter/scssfmt/tree/master/test/fixtures).\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 Masaaki Morishita\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatype%2Fscssfmt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatype%2Fscssfmt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatype%2Fscssfmt/lists"}