https://github.com/drewml/scd
Fast, drop-in replacement for Magento's Static Content Deploy (WIP)
https://github.com/drewml/scd
Last synced: 11 months ago
JSON representation
Fast, drop-in replacement for Magento's Static Content Deploy (WIP)
- Host: GitHub
- URL: https://github.com/drewml/scd
- Owner: DrewML
- Created: 2019-06-01T09:07:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:14:57.000Z (over 3 years ago)
- Last Synced: 2025-04-15T07:28:10.388Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 769 KB
- Stars: 23
- Watchers: 4
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
scd
Fast, drop-in replacement for Magento's Static Content Deploy
## Why?
For background on the motivations for the `scd` project, please see [the original proposal](https://github.com/magento/architecture/pull/168).
## How to use
This project is not quite ready yet, and many features from Magento core are not supported just yet. If you want to live on the bleeding edge, you can follow the developer instructions below.
## How to work on `scd`
1. Ensure you have a version of `node.js` locally that is >= `v10.12.0`
2. Clone the repository
3. In the root, run `npm install`
4. Run `npm test` to verify you've set everything up properly. All tests are expected to pass
## How to run against a store locally
1. Run [`npm link`](https://docs.npmjs.com/cli/link) in the root of this repository _once_. This will add the global `scd` command to your `$PATH`
You can now run `scd` in the root directory of any Magento 2 store locally.
## What works for far?
Only one scenario has been tested and developed against so far. This is:
- Stock store on 2.3-develop
- Using Luma
- Only targeting `en_US`
Things that have not been tested yet:
- Translations (they're not even implemented, so they surely don't work)
- `adminhtml` theme(s) (they might work, but I haven't tested)
- Deploying multiple themes at once. It might work (untested), but they're currently processed serially
## Should I use this for Production?
You're probably not going to listen to me, but I wouldn't just yet.
## Unsupported Features
See [`UNSUPPORTED.md`](UNSUPPORTED.md)
## Design Goals
- Favor speed over memory consumption _always_. Memory is cheap, time is not
- (Except in rare cases) data structures passed between module boundaries should be limited to those that can be easily serialized to JSON. This keeps it possible to move modules to a worker or use caches for only certain tasks later.
- Always favor optimizing code over caching
- Only add caching in places where slow things cannot otherwise be sped up
- Caches are always a bug farm in build tools
- Thoroughly loggable/traceable
- As much of the code base should be stateless as possible. Keep state confined to well-defined areas
- Keep root path handling separate from relative path handling
- Any persistent caching should work even when store is moved to another dir on disk or copied to another fs
- Compiled/released version should be compatible with Windows, but only \*nix compat is fine for building the project and running tests