https://github.com/surfstudio/surf-dcm-presets

Made by Surf 🏄
https://github.com/surfstudio/surf-dcm-presets

Last synced: 3 months ago
JSON representation

Made by Surf 🏄

• Host: GitHub
• URL: https://github.com/surfstudio/surf-dcm-presets
• Owner: surfstudio
• License: apache-2.0
• Created: 2024-02-05T09:28:37.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-08-05T12:44:47.000Z (4 months ago)
• Last Synced: 2025-08-05T14:34:37.141Z (4 months ago)
• Homepage:
• Size: 48.8 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Surf DCM Presets





Made by [Surf 🏄‍♂️🏄‍♂️🏄‍♂️](https://surf.dev/)

[![Build Status](https://shields.io/github/actions/workflow/status/surfstudio/surf-dcm-presets/on_pull_request.yml?logo=github&logoColor=white)](https://github.com/surfstudio/surf-dcm-presets)

[![Pub Version](https://img.shields.io/pub/v/surf_dcm_presets?logo=dart&logoColor=white)](https://pub.dev/packages/surf_dcm_presets)

[![Pub Likes](https://badgen.net/pub/likes/surf_dcm_presets)](https://pub.dev/packages/surf_dcm_presets)

[![Pub popularity](https://badgen.net/pub/popularity/surf_dcm_presets)](https://pub.dev/packages/surf_dcm_presets/score)

![Flutter Platform](https://badgen.net/pub/flutter-platform/surf_dcm_presets)

## Overview

This repository contains a list of pre-set presets for DCM that are used on Surf projects:

- **All:** contains all available lint rules.

- **Dart:** contains all lint rules applicable to any Dart app.

- **Flutter:** contains all lint rules applicable to any Flutter app.

- **Provider:** contains all lint rules for the Provider package.

- **Intl:** contains all lint rules for the Intl package.

- **Pub:** contains all lint rules for linting the `pubspec.yaml` files.

## Installation

Take these steps to enable a preset:

Install this package as a dev dependency:

   ```terminal

   dart pub add --dev surf_dcm_presets

   ```

   or:

   ```terminal

   flutter pub add --dev surf_dcm_presets

   ```

## Example

For DCM configuration add the `extents` entry:

   ```yaml

   dart_code_metrics:

     extends:

       - package:surf_dcm_presets/all.yaml

   ```

## Disabling or reconfiguring a rule from the preset

To disable a rule, simply set its value to false:

```yaml

dart_code_metrics:

  extends:

    - package:surf_dcm_presets/all.yaml

  rules:

    - avoid-banned-imports: false

```

To reconfigure a rule, that is included into a preset:

```yaml

dart_code_metrics:

  extends:

    - package:surf_dcm_presets/all.yaml

  rules:

    - arguments-ordering:

        child-last: true

```

## Defining a custom preset

Any other preset can be passed to the `extends` entry. To create a custom preset create a `yaml` file with the same structure as for regular [DCM configuration](https://dcm.dev/docs/configuration/).

## How to reach us

Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.

[![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/SurfGear)