Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fgw doc improvements #2330

Merged
merged 6 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

All bundles made with Babel have the same features, regardless of the bundler that was used.
All bundles made with [Babel](https://babeljs.io/) have the same features, regardless of the bundler that was used.

Except Gulp that will not use Babel to create your final bundle.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Language features

TypeScript is a superset of EcmaScript 2015, in this section we will cover what is added on top of it.
For EcmaScript 2015 features, you can check out our [Babel preset's features](../05_crafty-preset-babel/JavaScript_Features.md).
For ESNext features, you can check out our [Babel preset's features](../05_crafty-preset-babel/JavaScript_Features.md).

### Interfaces

Expand Down
11 changes: 5 additions & 6 deletions docs/Why.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ best out of each one.

### Features

We support the full EcmaScript 2015 and EcmaScript 2016 Specifications, Advanced CSS with the help
We support the latest EcmaScript Specifications, Advanced CSS with the help
of PostCSS and also TypeScript.

The features are best explained in each specific section :
Expand Down Expand Up @@ -52,13 +52,12 @@ come often, always improved documentation and reliability.
## Why we developed our solution instead of an existing one

Some solutions outside Swissquote do a similar job, like
[neutrino](https://neutrino.js.org/). But they tend to be too
[neutrino](https://neutrinojs.org/). But they tend to be too
opinionated and not offering options to tailor the solution to our needs.
Or they are made for one specific tool.

For example:

- [create-react-app](https://github.com/facebookincubator/create-react-app) is
meant to create React applications with Babel and Webpack. You can't use
TypeScript and you are limited to one bundle.
- [neutrino](https://neutrino.js.org/) is more configurable but still allows to is limited to one bundle and Webpack.
- [create-react-app](https://create-react-app.dev/) is
meant to create React applications with Babel and Webpack. You are limited to one bundle.
- [neutrino](https://neutrinojs.org/) is more configurable but still allows to is limited to one bundle and Webpack.
31 changes: 15 additions & 16 deletions docs/config.json
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
{
"title": "Crafty",
"tagline": "The task runner that binds them all",
"author": "Swissquote Bank SA",
"html": {
"theme": "swissquote",
"repo": "swissquote/crafty",
"google_analytics": "UA-113355094-2",
JonathanLink marked this conversation as resolved.
Show resolved Hide resolved
"toggle_code": false,
"links": {
"Technical blog": "https://medium.com/swissquote-engineering",
"Swissquote": "https://swissquote.com/",
"GitHub": "http://github.com/swissquote/crafty"
},
"powered_by": "© 2018 Swissquote Bank SA. Powered by Daux.io."
}
}
"title": "Crafty",
"tagline": "The task runner that binds them all",
"author": "Swissquote Bank SA",
"html": {
"theme": "swissquote",
"repo": "swissquote/crafty",
"toggle_code": false,
"links": {
"Technical blog": "https://medium.com/swissquote-engineering",
"Swissquote": "https://swissquote.com/",
"GitHub": "http://github.com/swissquote/crafty"
},
"powered_by": "© 2018 Swissquote Bank SA. Powered by Daux.io."
}
}
2 changes: 1 addition & 1 deletion packages/crafty-preset-swc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Description

**SWC** is the leading tool to compile EcmaScript 2015+ to EcmaScript 5, combined with **ESLint** to lint your code, you get the best preset to get started.
[**SWC**](https://swc.rs/) is the leading tool to compile EcmaScript 2015+ to EcmaScript 5, combined with **ESLint** to lint your code, you get the best preset to get started.

## Features

Expand Down
2 changes: 1 addition & 1 deletion packages/crafty-preset-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Microsoft presents TypeScript as "JavaScript that scales".
TypeScript is a superset of JavaScript that allows you to type your code.
Not everything needs to have a type as the tool is powerful enough to infer most of the types.

TypeScript has types but it also supports the full EcmaScript 2015 Specification.
TypeScript has types but it also supports the ESNext Specification.

## Features

Expand Down
6 changes: 6 additions & 0 deletions packages/crafty-runner-webpack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ module.exports = {

// For example, adding supported extensions to the resolution
chain.resolve.extensions.add(".ts").add(".tsx").add(".mts").add(".cts");

// For example to add a reverse proxy
chain.devServer.set("middleware", (app, builtins) => {
app.use(builtins.proxy('/hey', { target: 'https://google.com' }));
});

}
};
```
Loading