Service

A brick to create your service and interface with your defined methods. With optional singleton handling!

How to use 🚀

mason make service --service_name service --singleton_type static-instance-singleton

Variables ✨

Outputs 📦

--service_name "login service" --singleton_type static-instance-singleton
├── login_service.dart
├── ilogin_service.dart
└── ...

//--service_name "static service" --singleton_type static-instance-singleton
part 'istatic_service.dart';

class StaticService implements IStaticService {
  const StaticService._();
  static final StaticService instance = StaticService._();

  @override
  FutureOr<String> myMethod() async {
    //TODO: Add Logic
    return Future.value();
  }
}

//istatic_service.dart
part of 'static_service.dart';

/// A description for static service
abstract class IStaticService{
  /// A description for myMethod
  FutureOr<String> myMethod();
}

//--service_name "factory service" --singleton_type factory-singleton
part 'ifactory_service.dart';

class FactoryService implements IFactoryService {
  const FactoryService._();
  static final FactoryService _instance = FactoryService._();

  factory FactoryService() {
    return _instance;
  }

  @override
  FutureOr<String> myMethod() async {
    //TODO: Add Logic
    return Future.value();
  }
}

//ifactory_service.dart
part of 'factory_service.dart';

/// A description for factory service
abstract class IFactoryService{
  /// A description for myMethod
  FutureOr<String> myMethod();
}

//--service_name service --singleton_type none
part 'iservice.dart';

class Service implements IService {
  const Service();

  @override
  FutureOr<String> myMethod() async {
    //TODO: Add Logic
    return Future.value();
  }
}

//iservice.dart
part of 'service.dart';

/// A description for service
abstract class IService {
  /// A description for myMethod
  FutureOr<String> myMethod();
}

Roadmap

• Support for getIt

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 service

# Install globally
mason add -g service

Usage 🚀

mason make service

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

0.0.4

• feat: Change service format to split on ' ' instead of '/' making it easier for developers to type methods

0.0.3

• feat: Add documentation for generated service

0.0.2

• chore: Update documentation

0.0.1

• feat: Create initial Service Brick

MIT License

Copyright (c) 2022 Luke Moody

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.