swc-project/website

Documentation for the SWC project.

SWC Website

Built Using

• Next.js
• Nextra
• Vercel

website's Issues

Dark mode for logos?

The logos shown on SWC website does not follow dark mode as shown in the screenshot below:

Screenshot

It would be good to add dark mode for logos as shown in the screenshot below:

Screenshot

Error unknown field keepClassnames/keepFnames in swc config

Steps to reproduce

Create swc config file and set keepClassnames and keepFnames of mangle options as described in documentation.

Results

Expected

Flags should be applied, no errors in terminal

Actual

Flags are not applied error in the console

Module build failed (from ./node_modules/swc-loader/src/index.js):
Error: unknown field keepClassnames, expected one of props, topLevel, keepClassNames, keepFnNames, keepPrivateProps, ie8, safari10, reserved at line 1 column 750

Update 1

Repository with min code needed to reproduce

https://github.com/kaczor6418/swc-flags-typo

Results:

• After running npm run build at master branch:
  

• After running npm run build at fixed-flags-names branch
  

How Do I Migrate from Babel to swc??

@kdy1
Hello!
Recently I tried to use swc instead of babel and I found this page.
However I can't migrate from babel becase I could not find any npm packages which takes the place of babel-preset-env.
How do I migrate from babel to swc??

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Open

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

• fix(deps): pin dependencies (chart.js, react-chartjs-2)
• chore(deps): update dependency @tsconfig/docusaurus to v1.0.4
• chore(deps): update dependency @types/react to v17.0.34
• chore(deps): update dependency @types/react-helmet to v6.1.4
• chore(deps): update dependency typescript to v4.4.4
• fix(deps): update dependency codemirror to v5.63.3 (codemirror, @types/codemirror)
• fix(deps): update docusaurus monorepo to v2.0.0-beta.9 (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/preset-classic)
• chore(deps): update actions/checkout action to v2.4.0
• chore(deps): update dependency @types/react-router-dom to v5.3.2
• chore(deps): update dependency github-buttons to v2.19.1
• fix(deps): update dependency chart.js to v3.6.0
• fix(deps): update dependency react-chartjs-2 to v3.3.0
• chore(deps): update jamesives/github-pages-deploy-action action to v4
• fix(deps): update react monorepo to v17 (major) (react, react-dom)
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

---

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

Feedback for “Compilation”

It would be helpful if the documentation for this page actually listed out what the valid options are. For example, the entry on jsc.target only shows you one valid option - es2016

change the copy right year to the current year

should using the latest version of "@swc/web" in REPL

Feedback for “@swc/core”

About "parseFile" function, How to obtain rows and columns?

Better disclaimer on "usage" mode

Hi,

Right now we have a disclaimer in the Supported browsers page https://swc.rs/docs/configuration/supported-browsers#mode which says "The usage mode is currently not as efficient as Babel, yet.".

It great that we have that disclaimer, but I don't really understand what the efficiency tradeoff is here - are we adding more polyfills vs babel? Or is there a risk of of under-polyfill with this option? It would be good to add this information here, so users can understand what they are missing out on with this option.

Any plan to support i18n?

I am introducing swc to my team

At present, I want to know whether the official documentation of swc intends to support multiple languages, such as Chinese

By the way, I think I have time and ability to provide a Chinese translation version of the website, And If the main site provides a multi-language framework, it may be more convenient for more multi-language support.

Anyhow, I would like to know about the plans of the core team.

REPL / playground

I believe that is must-have feature.
Should we organize one @kdy1?

Question about documentation

The following line, what does it mean?

website/pages/docs/usage/core.mdx

Line 9 in bdd4732

`@swc/core` provides appropriate `.d.ts` file, so you may not need this. Returns `Promise<{ code: string, map?: string }>`

Thank you.

`plugin/ecmascript/getting-started`'s code is not working

https://swc.rs/docs/plugin/ecmascript/getting-started
I tried to follow this document but the contents seem to be out of date.

e.g.

- e.visit_mut_children_with(self);
+ e.span.visit_mut_children_with(self);

- e.left = Ident::new("kdy1".into(), e.left.span()).into();
+ e.left = Box::new(Ident::new("akfm".into(), e.left.span()).into());

Suggestion to apply community i18n based on SWR docs

The SWR website (vercel/swr-site) also uses Nextra to seve documentation for users and it accepts 18n translations from the community. It's possible to achieve it by only using default Nextra i18n configuration.

Is there plans to start accepting it?

I'm interested to contributing by translating docs to pt-BR. If it's necessary, I'm willing to prepare the field for community docs i18n.

@swc/jest: Config snippet does not pass TSC

The following config snippet from the docs does not pass TSC (after renaming the config file to .ts and adding type annotations):

module.exports = {
  transform: {
    "^.+\\.(t|j)sx?$": ["@swc/jest"],
  },
};

TSC:

TSError: ⨯ Unable to compile TypeScript:
jest.config.ts:14:3 - error TS2322: Type '[string]' is not assignable to type 'string | TransformerConfig'.
  Type '[string]' is not assignable to type 'string'.

'^.+\\.(t|j)sx?$': [ '@swc/jest' ],

---

I think it should be either @swc/jest as a plain string or [ '@swc/jest', {} ] with an empty record.

Show AST in REPL

Show AST in https://swc.rs/repl

Document `jsc.paths` option

Website is down

Unable to load the website

Incorrect @swc/jest description

From

website/pages/docs/usage/jest.md

Line 3 in 35da4af

To make your Jest tests run faster, you can swap out the default JavaScript-based runner (`ts-jest`) for a [drop-in Rust replacement](https://github.com/swc-project/jest) using SWC.

:

To make your Jest tests run faster, you can swap out the default JavaScript-based runner (ts-jest) for a drop-in Rust replacement using SWC.

The "default" Jest runner for TypeScript is actually¹ Babel with @babel/preset-typescript.

Neither @swc/jest nor the Babel TypeScript setup support type-checking, whilst ts-jest does.

This makes @swc/jest a drop-in replacement for the actual default runner, but not for the one that is mentioned :)

Footnotes

1. https://jestjs.io/docs/getting-started#using-typescript ↩

Fix build failure

error logs: https://github.com/swc-project/website/runs/2958415071?check_suite_focus=true

SWC.rs does not load

SWC.rs site doesn't load for me. My network is fine, and all other websites are working fine.

Document Cache-Busting

I assume it's possible to use swc add content hashes to generated files and use these. I did not find any documentation though.

Migrate website from Docusaurus Verion 1 to version 2

Description

New version has better looks and feel and comes with support for MDX and other plugins.

RSS support for /blog

Please add RSS support so that we can follow.

Deployment with Docusaurus v2

I think an update is needed to the deployment process with the upgrade

https://v2.docusaurus.io/docs/deployment#triggering-deployment-with-github-actions

I don't have the right level of permissions for this project to be able to complete the needed changes. Happy to help though

Update migrate from babel

Hey all, love the work that is being done by the swc project. Was looking over the Migrate from babel page and noticed that it is significantly behind on what stage plugins are at as compared to also what's included in swc. Is there any work going on behind the scenes to update the docs site? Or is this something that can be contributed

Validate Dom nesting warning in console

This warning appears in dev on the index route

It's due to p tags not being wrapped in {} which means another p tag is appended to the first p tag

<div className="mx-auto max-w-full w-[880px] text-center px-4 my-10">
  <p className="text-lg mb-2 text-gray-600 md:!text-2xl">
    Rust-based platform for the Web
  </p>
</div>

vs

<div className="mx-auto max-w-full w-[880px] text-center px-4 my-10">
  {<p className="text-lg mb-2 text-gray-600 md:!text-2xl">
    Rust-based platform for the Web
  </p>}
</div>

I'll be opening a PR with a solution shortly, Hope that's okay.

Some links in the footer are broken.

Some links like Installation in the footer are broken at https://swc-project.github.io/docs/installation

Website is not Mobile responsive

The Website is Not Responsive on the mobile screens. I wanted to contribute to this section .

`jsc.baseUrl` docs are confusing

The docs for the jsc.baseUrl setting are incredibly minimal -- merely a link to some typescript docs. Unfortunately Typescript's docs have changed since the link was created, and no longer offer an immediately useful explanation for what value should be used. The page in question no longer seems to exist, with users instead redirected to general background reading on module resolution.

Ideally the docs would be reasonable self-sufficient, at least providing a basic summary of what the config option does, even if they link out to other sources for background context.

Moved from swc-project/swc#8605.

Path aliases doesn't work

Having my .swcrc file written as follows:

{
  "$schema": "https://json.schemastore.org/swcrc",
  "sourceMaps": true,
  "module": {
    "type": "commonjs"
  },
  "jsc": {
    "target": "es2017",
    "parser": {
      "syntax": "typescript",
      "decorators": true,
      "dynamicImport": true
    },
    "transform": {
      "legacyDecorator": true,
      "decoratorMetadata": true
    },
    "keepClassNames": true,
    "baseUrl": "./src",
    "paths": {
        "shared/*": ["../../../shared/*"]
    },
  },
  "minify": false
}

And my tsconfig.json written as follows:

{
	"compilerOptions": {
		"outDir": "dist",
		"baseUrl": "src",
		"paths": {
			"shared/*": ["../../../shared/*"]
		},
		"sourceMap": true,
		"inlineSources": true,
		"target": "ES6"
	},
	"noImplicitAny": false,
	"strictNullChecks": false,
	"extends": "../../tsconfig.json"
}

When using tsc I'm receiving the right bundle with the shared directory bundled in the dist, but when using the swc build the dist directory doesn't contain the shared folder at all