Skip to content

Commit

Permalink
changed package name from fractal-fork to @innoq/fractal-fork
Browse files Browse the repository at this point in the history
  • Loading branch information
joyheron committed Sep 4, 2023
1 parent c444069 commit 04d4e0a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ fractal-fork version history
unreleased
----------

* TBD
* [major] changed package name from `fractal-fork` to `@innoq/fractal-fork`


0.1.2
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
fractal-fork
@innoq/fractal-fork
============

<p>
Expand Down Expand Up @@ -26,22 +26,22 @@ We have used Fractal successfully in customer projects and therefore have the de

We use real Fractal projects to test any changes that we make to the source code. However, this also means that **any feature that we do not personally use for any Fractal projects is at risk of being removed in the future** (especially if it uses dependencies which are poorly maintained).

## Migration Guide from `@frctl/fractal` to `fractal-fork`
## Migration Guide from `@frctl/fractal` to `@innoq/fractal-fork`

The changes to offical Fractal branch are listed here as follows:

* `fractal-fork` uses a single repository for ease of deployment. To migrate from `@frctl/fractal` to `fractal-fork` do the following:
* Replace `require('@frctl/core')` with `require('fractal-fork').core`
* Replace `require('@frctl/fractal')` with `require('fractal-fork').fractal`
* Replace `require('@frctl/handlebars')` with `require('fractal-fork').handlebars`
* Replace `require('@frctl/mandelbrot')` with `require('fractal-fork').mandelbrot`
* Replace `require('@frctl/web')` with `require('fractal-fork').web`
* `@innoq/fractal-fork` uses a single repository for ease of deployment. To migrate from `@frctl/fractal` to `@innoq/fractal-fork` do the following:
* Replace `require('@frctl/core')` with `require('@innoq/fractal-fork').core`
* Replace `require('@frctl/fractal')` with `require('@innoq/fractal-fork').fractal`
* Replace `require('@frctl/handlebars')` with `require('@innoq/fractal-fork').handlebars`
* Replace `require('@frctl/mandelbrot')` with `require('@innoq/fractal-fork').mandelbrot`
* Replace `require('@frctl/web')` with `require('@innoq/fractal-fork').web`
* Replace the `fractal` command in your package.json scripts with `fractal-fork`
* Automatic port discovery is not supported for `fractal-fork`. If a port is blocked, `fractal-fork` will quit with an error and it is the developer's responsibility to set a different port via `--port`.
* `fractal-fork` does not support the `--sync` option for the `start` command. This simplifies the implementation and avoids security vulnerabilities introduces by the `browser-sync` dependency
* `fractal-fork` does not support the `twig`, `nunjucts`, or `react` adapters (if you still need them, it should be possible for you to maintain a separate fork for those adapters)
* `fractal-fork` does not support the `new` CLI command (it's a command that is rarely used because it is only necessary to create the repository once. The alternative is to create the repository structure and `fractal.config.js` by hand. The CLI command was one area which had horrible dependencies which needed to be removed)
* The CLI output for `fractal-fork` is much less pretty -- there are no colors and the console never overwrites previous log output. This means particularly for the `build` command that the console output is much longer
* Automatic port discovery is not supported for `@innoq/fractal-fork`. If a port is blocked, `@innoq/fractal-fork` will quit with an error and it is the developer's responsibility to set a different port via `--port`.
* `@innoq/fractal-fork` does not support the `--sync` option for the `start` command. This simplifies the implementation and avoids security vulnerabilities introduces by the `browser-sync` dependency
* `@innoq/fractal-fork` does not support the `twig`, `nunjucts`, or `react` adapters (if you still need them, it should be possible for you to maintain a separate fork for those adapters)
* `@innoq/fractal-fork` does not support the `new` CLI command (it's a command that is rarely used because it is only necessary to create the repository once. The alternative is to create the repository structure and `fractal.config.js` by hand. The CLI command was one area which had horrible dependencies which needed to be removed)
* The CLI output for `@innoq/fractal-fork` is much less pretty -- there are no colors and the console never overwrites previous log output. This means particularly for the `build` command that the console output is much longer


[Read the full Fractal documentation][docs]
Expand All @@ -60,14 +60,14 @@ Check out the [documentation][docs] for more information.
### Install into your project (recommended)

```shell
npm install fractal-fork --save-dev
npm install @innoq/fractal-fork --save-dev
```

Then create your `fractal.config.js` file in the project root, and configure using the [official documentation][docs] but keeping in mind the changes to imports listed out in [the migration guide](#migration-guide-from-frctlfractal-to-fractal-fork).
Then create your `fractal.config.js` file in the project root, and configure using the [official documentation][docs] but keeping in mind the changes to imports listed out in [the migration guide](#migration-guide-from-frctlfractal-to-innoqfractal-fork).

An example pattern library using the `fractal-fork` library can be found in the `example` folder.
An example pattern library using the `@innoq/fractal-fork` library can be found in the `example` folder.

Then you can either run `npx fractal start` to start up the project, or create an alias under the `scripts` section in your package.json as a shortcut.
Then you can either run `npx fractal-fork start` to start up the project, or create an alias under the `scripts` section in your package.json as a shortcut.

e.g.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "fractal-fork",
"name": "@innoq/fractal-fork",
"version": "0.1.2",
"description": "A fork of the popular Fractal Pattern Library",
"main": "src/index.js",
Expand Down

0 comments on commit 04d4e0a

Please sign in to comment.