prettier-config-ali

1.5.0 verified Sat Apr 25 auth: no javascript

Prettier shareable configuration for Alibaba F2E Guidelines. Version 1.5.0 requires Node.js >=20.8.0 and is ESM-only. It enforces the formatting rules defined by the Alibaba Front-End Specification. Unlike generic Prettier configs like @company/prettier-config, this is tailored specifically for Alibaba's internal coding style. The package ships TypeScript type definitions and is part of the f2e-spec monorepo. It is a simple configuration object with no runtime dependencies.

Common errors

error Error [ERR_REQUIRE_ESM]: require() of ES Module ↓

cause Trying to require an ESM-only package with CommonJS require.

fix

Use import/export syntax or dynamic import(). Change to ESM by adding 'type': 'module' to package.json.

error Cannot find module 'prettier-config-ali' ↓

cause Package not installed or not in node_modules.

fix

Run 'npm install --save-dev prettier prettier-config-ali'.

Warnings

breaking Package is ESM-only starting from version 1.5.0. Using require('prettier-config-ali') will throw ERR_REQUIRE_ESM. ↓

fix Use import/export syntax and set package type to module or use dynamic import().

breaking Node.js version must be >=20.8.0 starting from version 1.5.0. ↓

fix Upgrade Node.js to 20.8.0 or higher.

gotcha Prettier is optional for f2elint users; manual installation is only needed if not using f2elint. ↓

fix Use f2elint to scaffold project and enable Prettier automatically.

Install

npm install prettier-config-ali

yarn add prettier-config-ali

pnpm add prettier-config-ali

Imports

prettier-config-ali

wrong

const prettierConfigAli = require('prettier-config-ali')

correct

import prettierConfigAli from 'prettier-config-ali'

Package is ESM-only since v1.5.0; CommonJS require will fail with ERR_REQUIRE_ESM.

prettier config in package.json
wrong
```
"prettier": "prettier"
```
correct
```
"prettier": "prettier-config-ali"
```
Set the 'prettier' key in package.json to the string 'prettier-config-ali'. Do not use a package name like 'prettier'.

prettier.config.js with spread

wrong

const aliConfig = require('prettier-config-ali');
module.exports = { ...aliConfig, semi: false }

correct

import aliConfig from 'prettier-config-ali';
export default { ...aliConfig, semi: false }

Since v1.5.0, ESM imports are required. Use import/export syntax, not require/module.exports.

Quickstart

Shows how to install and configure prettier-config-ali via package.json.

// Install
// npm install --save-dev prettier prettier-config-ali

// package.json
{
  "prettier": "prettier-config-ali"
}