{"id":23221817,"url":"https://github.com/nass600/icomoon-builder","last_synced_at":"2025-08-19T10:32:36.628Z","repository":{"id":57270891,"uuid":"111717511","full_name":"nass600/icomoon-builder","owner":"nass600","description":"Update your icons library project from the zip generated by icomoon","archived":false,"fork":false,"pushed_at":"2018-05-14T17:34:54.000Z","size":578,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T06:27:22.150Z","etag":null,"topics":["build-tool","css","export","icomoon","less","nodejs","scss","stylus"],"latest_commit_sha":null,"homepage":"","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/nass600.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-11-22T18:11:23.000Z","updated_at":"2023-11-05T06:26:16.000Z","dependencies_parsed_at":"2022-09-15T12:30:29.842Z","dependency_job_id":null,"html_url":"https://github.com/nass600/icomoon-builder","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nass600%2Ficomoon-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nass600%2Ficomoon-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nass600%2Ficomoon-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nass600%2Ficomoon-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nass600","download_url":"https://codeload.github.com/nass600/icomoon-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230345899,"owners_count":18212000,"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":["build-tool","css","export","icomoon","less","nodejs","scss","stylus"],"created_at":"2024-12-18T22:18:27.428Z","updated_at":"2024-12-18T22:18:28.110Z","avatar_url":"https://github.com/nass600.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# icomoon-builder\n\n[![Build Status](https://api.travis-ci.org/nass600/icomoon-builder.svg?branch=master)](https://travis-ci.org/nass600/icomoon-builder)\n[![npm](https://img.shields.io/npm/v/icomoon-builder.svg)](https://www.npmjs.com/package/icomoon-builder)\n[![npm](https://img.shields.io/npm/dt/icomoon-builder.svg)](https://www.npmjs.com/package/icomoon-builder)\n\n\nUpdate your icons library project from the zip generated by [icomoon](https://icomoon.io/).\n\n\u003e Currently working only for SASS.\n\nIf you are developing your own icons library using the Icomoon tool and you find yourself doing the below process all the time this project might be useful for you.\n\n#### Normal process\n\n1. Download the zip file from icomoon.\n2. Uncompressing it.\n3. Copy pasting parts of code into your own.\n4. Moving files to the location you want.\n5. Minify the css file.\n\n#### Process with icomoon-builder\n\n1. Download the font from icomoon.\n2. Run `icomoon-builder`.\n\n## Features\n\n+ Uncompress the icomoon generated zip file for you.\n+ Pick the location where the fonts styles will be moved.\n+ Choose where to move the pre-processed and css styles separately.\n+ All references between all these files will be updated accordingly.\n+ Minify the distribution css with `cssnano`.\n+ Update the font family name with the one you chose.\n+ Will keep your `selection.json` generated by icomoon so you can resume your work.\n+ And many more (below examples).\n\n## Installation\n\n```bash\nnpm install --save-dev icomoon-builder\n```\n\n## Usage\n\nYou can run it directly in your terminal with Node:\n\n```bash\nnode node_modules/.bin/icomoon-builder export \u003cfontName\u003e \u003cicomoonZipFile\u003e \u003cpreProcessorPath\u003e \u003ccssPath\u003e \u003cfontsPath\u003e \u003cdocsPath\u003e\n```\n\nOr add it as a script in your `package.json`:\n\n```json\n\"scripts\": {\n    \"import\": \"icomoon-builder export\"\n}\n```\n\nAnd then run it:\n\n```bash\nnpm run import \u003cfontName\u003e \u003cicomoonZipFile\u003e \u003cpreProcessorPath\u003e \u003ccssPath\u003e \u003cfontsPath\u003e \u003cdocsPath\u003e\n```\n\n## Examples\n\n### Export\n\nConsidering the following files are the ones icomoon generates and compresses:\n\n```\n.tmp/\n├── demo-files\n|   ├── demo.css\n|   └── demo.js\n├── demo.html\n├── fonts\n|   ├── icomoon.svg\n|   ├── icomoon.ttf\n|   └── icomoon.woff\n├── Read Me.txt\n├── selection.json\n├── style.css\n├── style.scss\n└── variables.scss\n```\n\nWhen running:\n\n```bash\ncd your/path/to/fancy-icons-project/\nnode node_modules/.bin/icomoon-builder export fancy-icons ~/Downloads/icomoon.zip scss css fonts docs\n```\n\nWe will obtain:\n\n```\ntarget/\n├── css\n|   ├── fancy-icons.css\n|   └── fancy-icons.min.css\n├── docs\n|   ├── demo\n|   |   ├── index.html\n|   |   ├── scripts.js\n|   |   └── styles.css\n|   └── icomoon.json\n├── fonts\n|   ├── fancy-icons.svg\n|   ├── fancy-icons.ttf\n|   └── fancy-icons.woff\n└── scss\n    ├── fancy-icons.scss\n    ├── _icons.scss\n    └── _variables.scss\n```\n\nThe `export` command does not destroy directories so if you have more files in the destination folders they will remain the same.\n\nThe following is the list of files copied:\n\n| From                       | To                                          | Operations performed                                               |\n| -------------------------- | ------------------------------------------- | ------------------------------------------------------------------ |\n| .tmp/demo.html             | fancy-icons-project/docs/demo/index.html    | Updated references to assets                                       |\n| .tmp/demo-files/demo.css   | fancy-icons-project/docs/demo/styles.css    |                                                                    |\n| .tmp/demo-files/demo.js    | fancy-icons-project/docs/demo/scripts.js    |                                                                    |\n| .tmp/selection.json        | fancy-icons-project/docs/icomoon.json       | Renamed to icomoon.json                                            |\n| .tmp/style.css             | fancy-icons-project/css/fancy-icons.css     | Renamed to `\u003cfontName\u003e`, updated references                        |\n|                            | fancy-icons-project/css/fancy-icons.min.css | Minify the previous css                                            |\n| .tmp/fonts/line-icons.woff | fancy-icons-project/fonts/fancy-icons.woff  | Renamed to `\u003cfontName\u003e`                                            |\n| .tmp/fonts/line-icons.svg  | fancy-icons-project/fonts/fancy-icons.svg   | Renamed to `\u003cfontName\u003e`                                            |\n| .tmp/fonts/line-icons.ttf  | fancy-icons-project/fonts/fancy-icons.ttf   | Renamed to `\u003cfontName\u003e`                                            |\n| .tmp/style.scss            | fancy-icons-project/scss/_icons.scss        | Updated references and renamed `$icomoon-font-path`                |\n| .tmp/variables.scss        | fancy-icons-project/scss/_variables.scss    |                                                                    |\n|                            | fancy-icons-project/scss/fancy-icons.scss   | Imports the other two scss files. Created if does not exist before |\n\n### Clean\n\n\u003e Careful, this command is destructive and cannot be undone.\n\nRunning:\n\n```bash\ncd your/path/to/fancy-icons-project/\nnode node_modules/.bin/icomoon-builder clean scss css fonts docs\n```\n\nWill **remove entirely** the following folders:\n\n+ your/path/to/fancy-icons-project/scss\n+ your/path/to/fancy-icons-project/css\n+ your/path/to/fancy-icons-project/fonts\n+ your/path/to/fancy-icons-project/docs\n\n## Todo\n\n- [x] SASS\n- [ ] LESS\n- [ ] Stylus\n\n## License\n\n[MIT](LICENSE)\n\n## Authors\n\n+ [Ignacio Velazquez](http://ignaciovelazquez.es)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnass600%2Ficomoon-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnass600%2Ficomoon-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnass600%2Ficomoon-builder/lists"}