{"id":23594029,"url":"https://github.com/magicink/sass-colour-lover","last_synced_at":"2025-08-30T08:31:37.934Z","repository":{"id":21514596,"uuid":"24833697","full_name":"magicink/sass-colour-lover","owner":"magicink","description":"Auto-magically generate Sass color variables using palettes from COLOURLovers.","archived":false,"fork":false,"pushed_at":"2017-02-07T23:21:25.000Z","size":53,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"v2","last_synced_at":"2023-02-26T08:41:58.037Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magicink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-06T04:07:23.000Z","updated_at":"2021-08-09T18:04:24.000Z","dependencies_parsed_at":"2022-08-21T16:21:08.199Z","dependency_job_id":null,"html_url":"https://github.com/magicink/sass-colour-lover","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicink%2Fsass-colour-lover","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicink%2Fsass-colour-lover/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicink%2Fsass-colour-lover/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicink%2Fsass-colour-lover/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magicink","download_url":"https://codeload.github.com/magicink/sass-colour-lover/tar.gz/refs/heads/v2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231461742,"owners_count":18380303,"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":[],"created_at":"2024-12-27T09:14:47.995Z","updated_at":"2024-12-27T09:14:48.722Z","avatar_url":"https://github.com/magicink.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"sass-colour-lover\n=================\n\n![Build Status](https://api.travis-ci.org/magicink/sass-colour-lover.svg?branch=master)\n[![Dependency Status](https://david-dm.org/magicink/sass-colour-lover.svg)](https://david-dm.org/magicink/sass-colour-lover)\n[![NPM version](https://badge.fury.io/js/sass-colour-lover.svg)](http://badge.fury.io/js/sass-colour-lover)\n\nAuto-magically generate Sass color variables using palettes from [COLOURLovers][cl].\n\n### Installation\n\n#### `npm`\n\nFor day-to-day use, I recommend using `npm` to install `sass-colour-lover` globally.\n\n```sh\nnpm install -g sass-colour-lover\n```\n\n#### `git`\n\nIf you plan on contributing to this project, you can install `sass-colour-lover` locally using `git`.\n\nClone the project:\n\n```sh\ngit clone git@github.com:magicink/sass-colour-lover.git\n```\n\nNavigate into the project directory and the build dependencies:\n\n```sh\nnpm install\n```\n\nBuild\n\n```sh\ngrunt\n```\n\nInstall the module globally (may require administrative access)\n\n```sh\nnpm install . -g\n```\n\nOr, if you prefer, link it (may require administrative access)\n\n```sh\nnpm link\n```\n\nAt this point, the `sass-colour-lover` command will be available from your command prompt.\n\n### Usage\n\nAt a minimum, the ID of the palette needs to be passed to `sass-colour-lover`. There are two ways to do this.\n\nThe easiest way is go to [COLOURLovers][cl] and copy the address of a palette you like. After that, simply paste the url in as a parameter.\n\n```\nsass-colour-lover http://www.colourlovers.com/palette/3508876/Jujubee\n\n# These will also work:\n# http://colourlovers.com/palette/\u003cid\u003e\n# www.colourlovers.com/palette/\u003cid\u003e\n```\n\nThis generates a Sass file called `_palette.scss` in the current working directory. The contents of this file appear like this:\n\n```sass\n// Palette: Jujubee\n// Author: jaymepollock\n// http://www.colourlovers.com/palette/3508876/Jujubee\n\n$pomegranate-posey:   rgb(201,11,78);\n$down-by-the-sea:     rgb(8,20,52);\n$oj:                  rgb(201,132,11);\n$royale:              rgb(61,16,96);\n$purple-day:          rgb(136,12,114);\n```\n\nIf you would like to generate Sass variables from multiple palettes, you can use the `--ids=` parameter. Pass the IDs as a comma seperated list.\n\n```sh\nsass-colour-lover --ids=649208,32049,12345\n```\n\nThe contents of the generated file appear like so:\n\n```sass\n// Palette: Spavian\n// Author: Spammy\n// http://www.colourlovers.com/palette/12345/Spavian\n\n$ex8at:     rgb(104,119,128);\n$phi0phi:   rgb(80,87,91);\n$yum:       rgb(88,98,103);\n$won7phi:   rgb(104,113,117);\n$ine8ey:    rgb(152,164,169);\n\n// Palette: my front porch\n// Author: realitybites\n// http://www.colourlovers.com/palette/32049/my_front_porch\n\n$codex:                rgb(177,62,31);\n$red-light-district:   rgb(140,35,50);\n$satisfying-auburn:    rgb(171,72,0);\n$spyglass:             rgb(189,124,32);\n$doormat:              rgb(113,56,13);\n\n// Palette: thrill worth seeking\n// Author: lesaint\n// http://www.colourlovers.com/palette/649208/thrill_worth_seeking\n\n$cetiedil:             rgb(115,75,6);\n$love-pink:            rgb(186,48,87);\n$disposition:          rgb(160,173,62);\n$cotyl:                rgb(236,255,92);\n$green-clay:           rgb(140,125,28);\n```\n\n### Options\n\n`--file=/path/to/file`\n\nSpecifies where you would like to save your file.\n\n```\n# This produces a file called '_colors.scss'\n\nsass-colour-lover --ids=3143 --file=_colors.scss\n\n# Same file, one directory up\n\nsass-colour-lover --ids=3143 --file=../_colors.scss\n```\n\n`--color=(hex|rgb)`\n\nGenerate colors in either hexadecimal or RGB formats.\n\n```\nsass-colour-lover --ids=72313 --color=hex\n```\n\nGenerates\n\n```sass\n// Palette: cutty sark.\n// Author: bijouloveshues\n// http://www.colourlovers.com/palette/72313/cutty_sark.\n\n$earl-grey:              #DBDADD;\n$call-bradly:            #51524C;\n$landmark-restoration:   #2D3336;\n$full-english:           #DDBA47;\n$maritime-relic:         #285E7E;\n```\n\n### Variable Names\n\n`sass-colour-lover` tries its very best to generate variable names based on the names selected by the palette's authors. That being said [COLOURLovers][cl] allows for some pretty gnarly naming conventions that sometimes do not mesh well with Sass. There are likely to be edge cases that haven't been caught. Here are some things that get sanitized by `sass-colour-lover`\n\n#### Names with Leading Numbers\n\nNumbers cannot be used as the first character of a variable name. If detected, the string 'color-' is prepended to the start of the variable name.\n\n```sass\n// Palette: 2\n// Author: heheherrr\n// http://www.colourlovers.com/palette/3508938/2\n\n$spirit:      rgb(253,216,189);\n$flagwhite:   rgb(233,214,212);\n$fd5541:      rgb(253,85,65);\n$color-1:     rgb(41,44,65);\n$once-was:    rgb(242,176,160);\n```\n\n#### Duplicate Names\n\nIf a duplicate name is detected, a simple counter is appended to the end of all variables that share the name.\n\n```sass\n// Palette: That's Not Butter!?!\n// Author: retsof\n// http://www.colourlovers.com/palette/223567/Thats_Not_Butter!!\n\n$buffered-toast:     rgb(223,162,70);\n$buttered-toast:     rgb(253,205,10);\n$buttered-toast-1:   rgb(240,240,83);\n$buttered-toast-2:   rgb(209,158,102);\n$buttered-toast-3:   rgb(216,173,63);\n```\n\n#### Names with No Value\n\nSometimes names are entirely comprised of invalid characters. In which case, the color name is changed to `color`.\n\n#### Names that are crazy\n\nThey exist... and we love them anyway.\n\n```sass\n// Palette: ๓๏ภ๏t๏ภ๏ยร * l๏שє\n// Author: -Yonder-\n// http://www.colourlovers.com/palette/3508899/๓๏ภ๏t๏ภ๏ยร_*_l๏שє\n\n$turkwer:   rgb(200,214,186);\n$anew:      rgb(169,166,157);\n$l----l:    rgb(121,73,116);\n$l:         rgb(168,203,166);\n$l-1:       rgb(159,116,132);\n```\n\n### In the Works\n\n* Appending output to an existing stylesheet\n* Add option to use a different type of divider (i.e. `variable_name` as opposed to `variable-name`)\n\n[cl]: http://www.colourlovers.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicink%2Fsass-colour-lover","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagicink%2Fsass-colour-lover","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicink%2Fsass-colour-lover/lists"}