{"id":13517170,"url":"https://github.com/SnowdogApps/magento2-frontools","last_synced_at":"2025-03-31T07:31:06.955Z","repository":{"id":40762625,"uuid":"50524402","full_name":"SnowdogApps/magento2-frontools","owner":"SnowdogApps","description":"Set of front-end tools for Magento 2 based on Gulp.js","archived":false,"fork":false,"pushed_at":"2024-04-08T14:28:27.000Z","size":2531,"stargazers_count":429,"open_issues_count":17,"forks_count":140,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-03-23T23:15:10.209Z","etag":null,"topics":["browsersync","csslint","gulp","hacktoberfest","magento","magento2","magento2-extension","sass","sass-lint","stylelint","toolset","yarn"],"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/SnowdogApps.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-27T17:23:12.000Z","updated_at":"2024-12-30T09:24:19.000Z","dependencies_parsed_at":"2024-06-18T12:38:09.468Z","dependency_job_id":"015e8961-7d6f-446a-aa4f-18c092d5b5b7","html_url":"https://github.com/SnowdogApps/magento2-frontools","commit_stats":{"total_commits":483,"total_committers":34,"mean_commits":"14.205882352941176","dds":0.3561076604554866,"last_synced_commit":"2a5854781c970044af38aabdce2efa1a6bf9e56e"},"previous_names":[],"tags_count":86,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnowdogApps%2Fmagento2-frontools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnowdogApps%2Fmagento2-frontools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnowdogApps%2Fmagento2-frontools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SnowdogApps%2Fmagento2-frontools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SnowdogApps","download_url":"https://codeload.github.com/SnowdogApps/magento2-frontools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246395596,"owners_count":20770243,"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":["browsersync","csslint","gulp","hacktoberfest","magento","magento2","magento2-extension","sass","sass-lint","stylelint","toolset","yarn"],"created_at":"2024-08-01T05:01:30.657Z","updated_at":"2025-03-31T07:31:06.937Z","avatar_url":"https://github.com/SnowdogApps.png","language":"JavaScript","readme":"# **DEPRECATED** \n\n## This is no longer supported, please consider using [Cream fork](https://github.com/creaminternet/magento2-frontools) instead.\n\n\n[![Packagist](https://img.shields.io/packagist/v/snowdog/frontools.svg)](https://packagist.org/packages/snowdog/frontools) [![Packagist](https://img.shields.io/packagist/dt/snowdog/frontools.svg)](https://packagist.org/packages/snowdog/frontools)\n\n## Magento 2 Frontools\nSet of front-end tools for Magento 2\n\n## Requirements\n* Unix-like OS (please, do not ask about Windows support)\n* Node.js [LTS version](https://nodejs.org/en/about/releases/). We recommend using [Volta](https://volta.sh/).\n* Magento 2 project with SASS based theme for example [SASS version of \"Blank\"](https://github.com/SnowdogApps/magento2-theme-blank-sass) or [Alpaca Theme](https://github.com/SnowdogApps/magento2-alpaca-theme)\n\n## Installation\n1. Run `composer require snowdog/frontools`\n2. Go to package directory `cd vendor/snowdog/frontools`\n3. Run `yarn` or `npm install`\n4. Decide where you want to keep your config files.\nYou can store them in Frontools `config` directory or in `dev/tools/frontools/config` (recommended).\nThere is a `setup` task to copy all sample config files from the `config` to `dev/tools/frontools/config` and create a convenient symlink `tools` in the project root.\nIf you want to keep config files inside frontools `config` dir, you have to handle this manually.\n5. Define your themes in `themes.json`.\n\n## `themes.json` structure\nCheck `config/themes.json.sample` to get samples.\n- `src` - full path to theme\n- `dest` - full path to `pub/static/[theme_area]/[theme_vendor]/[theme_name]`\n- `locale` - array of available locales\n- `parent` - name of parent theme\n- `stylesDir` - (default `styles`) path to styles directory. For `theme-blank-sass` it's `styles`. By default Magento 2 use `web/css`.\n- `disableSuffix` - disable adding `.min` suffix using `--prod` flag.\n- `postcss` - (default `[\"autoprefixer({ overrideBrowserslist: browserslist })\"]`) PostCSS plugins config. Have to be an array.\n- `modules` - list of modules witch you want to map inside your theme\n- `ignore` - array of ignore patterns\n\n## `watcher.json` structure\nCheck `config/watcher.json.sample` to get samples.\n- `usePolling` - set this to `true` to successfully watch files over a network (i.e. Docker or Vagrant) or when your watcher dosen't work well. Warning, enabling this option may lead to high CPU utilization! [chokidar docs](https://github.com/paulmillr/chokidar#performance)\n\n## `sass-compiler.json` structure\nYou can choose Sass compiler between the default, but [already deprecated](https://github.com/sass/node-sass/issues/2952), `node-sass` or a newer and faster `dart-sass`.\n\nSince the Dart Sass does not have the same set of features as Node Sass, for now we will keep the older version as default.\n\n## Optional configurations for 3rd party plugins\nYou will find sample config files for theses plugins in `vendor/snowdog/frontools/config` directory.\n* Create [browserSync](https://www.browsersync.io/) configuration\n* Create [eslint](https://eslint.org/) configuration\n* Create [sass-lint](https://github.com/sasstools/sass-lint) configuration\n* Create [stylelint](https://github.com/stylelint/stylelint) configuration\n* Create [svg-sprite](https://github.com/jkphl/gulp-svg-sprite) configuration\n\n## Tasks list\nUse `yarn [taskName]` or `npm run [taskName]` to run the task.\n* `babel` - Run [Babel](https://babeljs.io/), a compiler for writing next generation JavaScript.\n  * `--theme name` - Process single theme.\n  * `--prod` - Production output - minifies and uglyfy code.\n* `clean` - Removes `/pub/static` directory content.\n* `csslint` - Run [stylelint](https://github.com/stylelint/stylelint) based tests.\n  * `--theme name` - Process single theme.\n  * `--ci` - Enable throwing errors. Useful in CI/CD pipelines.\n* `dev` - Runs [browserSync](https://www.browsersync.io/) and `inheritance`, `babel`, `styles`, `watch` tasks.\n  * `--theme name` - Process single theme.\n  * `--disableLinting` - Disable JS, SASS, CSS linting.\n  * `--disableMaps` - Disable inline source maps generation.\n* `emailfix` - Fixes email stylesheet for Magento \u003c 2.3.0. [Related issue](https://github.com/MyIntervals/emogrifier/issues/296)\n  * `--prod` - Production output - minifies styles and add `.min` sufix.\n* `eslint` - Run [eslint](https://eslint.org/) against all JS files.\n  * `--theme name` - Process single theme.\n  * `--fix` - Autofix errors\n  * `--ci` - Enable throwing errors. Useful in CI/CD pipelines.\n* `inheritance` - Create necessary symlinks to resolve theme styles inheritance and make the base for styles processing. You have to run in before styles compilation and after adding new files.\n* `magepackBundle` - Run [magepack](https://github.com/magesuite/magepack) `bundle` command.\n  * `-c` or `--config` - (required) Path to previously generated Magepack config file.\n  * `--theme name` - Process single theme.\n* `magepackGenerate` - Run [magepack](https://github.com/magesuite/magepack) `generate` command.\n  * `--cms-url` - (required) URL to one of CMS pages (e.g. homepage).\n  * `--category-url` - (required) URL to one of category pages.\n  * `--product-url` - (required) URL to one of product pages.\n  * `-u` or `--auth-username` - Username for Basic Auth.\n  * `-p` or `--auth-password` - Passoword for Basic Auth.\n  * `-d` or `--debug` - Turn on debugging mode.\n* `sasslint` - Run [sass-lint](https://github.com/sasstools/sass-lint) based tests.\n  * `--theme name` - Process single theme.\n  * `--ci` - Enable throwing errors. Useful in CI/CD pipelines.\n* `setup` - Creates a convenient symlink from `/tools` to `/vendor/snowdog/frontools` and copies all sample files if no configuration exists.\n  * `--symlink name` - If you don't want to use `tools` as the symlink you can specify another name.\n* `styles` - Use this task to manually trigger styles processing pipeline.\n  * `--theme name` - Process single theme.\n  * `--disableMaps` - Disable inline source maps generation.\n  * `--prod` - Production output - minifies styles and add `.min` suffix.\n  * `--ci` - Enable throwing errors. Useful in CI/CD pipelines.\n* `svg` - Run [svg-sprite](https://github.com/jkphl/gulp-svg-sprite) to generate SVG sprite.\n  * `--theme name` - Process single theme.\n* `watch` - Watch for style changes and run processing tasks.\n  * `--theme name` - Process single theme.\n  * `--disableLinting` - Disable JS, SASS, CSS linting.\n  * `--disableMaps` - Disable inline source maps generation.\n","funding_links":[],"categories":["JavaScript","Magento2","Open Source Extensions","Deployments"],"sub_categories":["Development Utilities","Full Page Caching"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnowdogApps%2Fmagento2-frontools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSnowdogApps%2Fmagento2-frontools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSnowdogApps%2Fmagento2-frontools/lists"}