fusionjs/fusionjs.github.io

Modern framework for fast, powerful React apps

Fusion.js Documentation

Contribute

Install the dependencies:

yarn install

Bootstrap:

yarn bootstrap

It clones all the documentation.

Run in dev mode:

yarn dev

The replaceRenderer from gatsby-ssr.js is not called during a development build (gatsbyjs/gatsby#3166), that results in a Styletron error "Uncaught TypeError: Cannot read property 'sheet' of undefined". As a temporary solution while in dev mode, remove the styleElements from passing to the client's Styletron instance in the gatsby-browser.js: const styletron = new Styletron(styleElements); => const styletron = new Styletron();.

Build docs website locally:

yarn build-docs

To add a new package to render its documentation:

• for public packages from github add the repo name to packages-oss.txt;

Then add a newly added package's docs to the side navigation menu in /src/nav-api.yml. A doc page of README of a package will be created with the path /api/[package_name]. Additional documentation for the package can live under its /docs folder, and pages for that documentation will be created with a full path like /api/[package_name]/docs/[file_name].

While adding or removing any documentation files in this repo under /documentation folder, don't forget to add/remove a side menu items to the docs in /src/nav-docs.yml.

fusionjs.github.io's Issues

Add Reframe to Framework Comparison

Would you guys be up for that? I'd create a PR and try to be unbiased.

Reframe (https://github.com/reframejs/reframe) is similar in that it focuses on modularity (it is also based on plugins that use integration points and DI) but is different in that it focuses on flexibility (it's progressively ejectable.)

Broken links

I was browsing through the documentation and there are a couple of broken links:

• https://fusionjs.com/docs/guides/security/ (from Google)
• https://fusionjs.com/measuring-browser-performance

Errors in plugin example?

I am reading the "creating a Fusion.js plugin" page but am a little confused, esp. about the following code:

// src/plugins/foo.js
import {createToken} from 'fusion-core';
import {ExampleToken} from '';

export const ExampleToken = createToken('ExampleToken');

export default createPlugin({
  deps: {example: ExampleToken},
  provides({example}) {
    example.sayHello();
  },
});

My problems are:

• ExampleToken is imported from ''. Is this valid?
• Another const ExampleToken is created and exported. Wouldn't it collide with the token already created in src/plugins/example.js, assuming createToken creates the same token given the same input?

I think the correct code would be

// src/plugins/foo.js
import {createToken} from 'fusion-core';
import {ExampleToken} from './example';

export const FooToken = createToken('FooToken');

export default createPlugin({
  deps: {example: ExampleToken},
  provides({example}) {
    example.sayHello();
  },
});

Please let me know. I'd be happy to submit a PR.

Mobile header nav broken

Top right navigation is not responsive, and overlays the content.

Add netlify

Setup netlify and deploy docs. Bonus points if we setup doc deployment on ever pull request.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>whitesource/merge-confidence:beta)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Replace dependency babel-eslint with @babel/eslint-parser ^7.11.0
• Update Yarn to v1.22.22
• Update uber/web-base-image Docker tag to v1.0.10
• Update gatsby monorepo (gatsby-remark-images, gatsby-remark-prismjs)
• Update npm to v5.10.0
• Update Node.js to v20
• Update dependency babel-eslint to v10
• Update dependency eslint to v9
• Update dependency eslint-config-prettier to v9
• Update dependency eslint-plugin-prettier to v5
• Update dependency just-safe-get to v4
• Update dependency prettier to v3
• Update dependency react-helmet to v6
• Update dependency styletron-react to v6
• Update dependency unist-util-visit to v5
• Update gatsby monorepo (major) (gatsby-link, gatsby-plugin-catch-links, gatsby-plugin-google-analytics, gatsby-plugin-react-helmet, gatsby-remark-autolink-headers, gatsby-remark-copy-linked-files, gatsby-remark-images, gatsby-remark-prismjs, gatsby-source-filesystem, gatsby-transformer-remark)
• Update npm to v10
• Update react monorepo to v18 (major) (react, react-dom)
• Update uber/web-base-image Docker tag to v14
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency prismjs to v1.24.0 [SECURITY]

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency express to v4.19.2 [SECURITY]
• Update dependency gatsby to v4 [SECURITY]
• Update dependency gatsby-plugin-sharp to v4 [SECURITY]
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

buildkite

.buildkite/pipeline.yml

docker-compose

docker-compose.yml

dockerfile

Dockerfile

• uber/web-base-image 1.0.4@sha256:54882a63e6d989100f351c6fbc3585922d3659c09384a74039f586d60f9635f8

npm

package.json

• express ^4.16.2
• gatsby ^1.9.17
• gatsby-link ^1.6.16
• gatsby-plugin-catch-links ^1.0.17
• gatsby-plugin-google-analytics ^1.0.14
• gatsby-plugin-react-helmet ^1.0.5
• gatsby-plugin-react-next ^1.0.4
• gatsby-plugin-sharp 2.0.35
• gatsby-remark-autolink-headers ^1.4.8
• gatsby-remark-copy-linked-files ^2.0.11
• gatsby-remark-images 3.0.11
• gatsby-remark-prismjs 3.2.9
• gatsby-source-filesystem ^1.4.12
• gatsby-transformer-remark ^1.7.7
• just-safe-get ^2.0.0
• prismjs ^1.15.0
• react ^16.8.0
• react-dom ^16.8.0
• react-helmet ^5.2.0
• styletron-client ^3.0.0-rc.1
• styletron-react ^3.0.0-rc.2
• styletron-server ^3.0.0-rc.1
• unist-util-visit ^1.2.0
• babel-eslint ^8.0.1
• eslint ^4.6.1
• eslint-config-prettier ^2.6.0
• eslint-plugin-prettier ^2.3.1
• eslint-plugin-react ^7.4.0
• prettier ^1.6.1
• node ^8.11.1
• npm 5.6.0
• yarn ^1.5.1
• node 8.17.0
• yarn 1.22.5

plugins/gatsby-remark-transform-links/package.json

---

• Check this box to trigger a request for Renovate to run again on this repository

Loading of plugin in run-time

Is it possible in fusionjs to implement a plugin based framework where you no information was available about plugin during compile/build time so its not added to the bundle and you load it in run-time on demand ?

Fusion API documentation broken

If you visit the API docs all the sub pages like "Apollo" https://fusionjs.com/api/fusion-plugin-apollo only show the "Fusion CLI" page.

Add navigation bar

We should have a navigation bar that links you to all documents and guides within this repo, as well as external plugin READMEs.

Assorted typos in contributing instructions and documentation

👋 Hi everyone. While going through the getting-started guide and the API documentation I found some assorted typos.

@KevinGrandon @AlexMSmithCA @nadiia it was great to meet you all at the meetup yesterday!

README.md

yarn boostrap bootstrap

content/tokens.md

You have a Fusion.js application with with many dependencies.

documentation/docs/getting-started/why-fusion.md

Our vendor JavaScript bundle small bundle is small through usage...

The core technologies recommended in these guids guides, such as React and Redux

Unrelated

Fusion is looking really good! Do you have any more repos with some more fleshed-out examples?