custom_lint_brick

This project uses a brick template to generate custom lints with mason.

Generated code is built on top of custom_lint.

Getting Started 🚀

This is a starting point for a new brick. A few resources to get you started if this is your first brick template:

• Official Mason Documentation
• Code generation with Mason Blog
• Very Good Livestream: Felix Angelov Demos Mason

Generate 💻

Take a look at how to initialize mason and then you can do mason make custom_lint_brick into a terminal.

CLI will ask you what kind of file name and corresponding classes you want to match.

E.g. if you have a file called authentication_service.dart and you want to have inside it a class called AuthenticationService and not only Authentication you can write service when CLI will ask you.

The same with bloc, model and so on.

mason_custom_lints folder contains a generated package that checks for _service and _bloc files.

Usage 🔨

Mason will generate a flutter package based on custom_lint package so the only thing you need to do to use it in your project is to add it to pubpsec and change the analysis_options file.

In your App add this to your pubspec.yaml:

dev_dependencies:
  custom_lint: 0.1.0
  mason_custom_lints:
    path: ../mason_custom_lints

And in your analysis_options.yaml add:

analyzer:
  plugins:
    - custom_lint

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add custom_lint_brick

# Install globally
mason add -g custom_lint_brick

Usage 🚀

mason make custom_lint_brick

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.39 <0.1.0"

0.1.0+7

• Fixed typo when updating dependencies

0.1.0+6

• Fixed typo
• Update README

0.1.0+5

• Update custom_lint and custom_lint_builder to last version

0.1.0+4

• Update README

0.1.0+3

• Removed tests from dev_dependencies

0.1.0+2

• README update

0.1.0+1

• Initial release of custom_lint_brick

MIT License

Copyright (c) 2022 marcotrumpet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.