prettier config for SBMC projects

This is the base prettier config for all SBMC projects. It includes configurations for general Prettier usage, as well as configurations for Angular and a config without organizing imports.

The configurations include the @prettier/plugin-xml plugin for XML formatting (in SAPUI5 projects) and the prettier-plugin-organize-imports plugin for organizing imports in TypeScript files.

Installation

npm install --save-dev @sbmc/prettier-config-sbmc prettier @prettier/plugin-xml typescript prettier-plugin-organize-imports

Usage

This package provides several configurations that you can extend in your own Prettier configuration file. You can create a .prettierrc.js or .prettierrc.cjs file in the root of your project and extend the desired configuration.

import { defaultConfig } from '@sbmc/prettier-config-sbmc';

/**
 * @type {import("prettier").Config}
 */
const config = {
  ...defaultConfig,
  // Any project level overrides or additional settings for Prettier can go here
  // See: https://prettier.io/docs/options
};

export default config;

Remember to always include the base config first, followed by any project-specific overrides. Otherwise, the base rules might override your custom rules.

Available Configurations

• defaultConfig: The standard Prettier configuration for most projects.
• angularConfig: A configuration tailored for Angular projects.
• noOrganizeImportsConfig: A configuration that does not include the organize imports plugin.

Note on Organize Imports

The defaultConfig and angularConfig include the prettier-plugin-organize-imports plugin, which automatically organizes your import statements. This is a destructive change, meaning it will modify your code by removing unused imports and sorting them. If you prefer not to have this behavior, you can use the noOrganizeImportsConfig instead or disable destructive code actions using:

{
  "organizeImportsSkipDestructiveCodeActions": true
}

See the prettier-plugin-organize-imports documentation for more details.

Contributing

When contributing to this repository, please ensure that your latest commit increments the version number in package.json according to semantic versioning principles. For example using npm version patch for bug fixes, npm version minor for new features, and npm version major for breaking changes.

License

(c) SBMC Solutions GmbH. All rights reserved.