Pine Page

A brick to create your pages (stateless, stateful and with or without routing) class including tests.

This brick makes use of the internal lib pine_bricks_helper to get access to the package name, so please run this brick in the root of your project where a valid pubspec.yaml file exists. Also, (eventually) make sure you have previously set up your project to work with the auto_route and the flutter_bloc library.

How to use 🚀

mason make pine_page --name "SignIn"

Variables ✨

Outputs 📦

--name "SignIn"
├── lib
│   └── pages
│       └── sign_in_page.dart
├── test
│   └── pages
│       └── sign_in_page
│           └── sign_in_page_test.dart
└── ...

Stateless Page File

import 'package:flutter/material.dart';
import 'package:auto_route/auto_route.dart';

/// Enter the SignIn documentation here
@RoutePage()
class SignInPage extends StatelessWidget {

  /// The constructor of the page.
  const SignInPage({super.key});

  @override
  Widget build(BuildContext context) => Placeholder();
}

Stateful Page File

import 'package:flutter/material.dart';
import 'package:auto_route/auto_route.dart';

/// Enter the SignIn documentation here
@RoutePage()
class SignInPage extends StatefulWidget {

  /// The constructor of the page.
  const SignInPage({super.key});

  @override
  State<SignInPage> createState() => _SignInState();
}

class _SignInState extends State<SignInPage> {
  @override
  void initState() {
    super.initState();
  }

  @override
  void dispose() {
    super.dispose();
  }

  @override
  Widget build(BuildContext context) => Placeholder();
}

Stateless Page File (with AutoRoute)

import 'package:flutter/material.dart';
import 'package:auto_route/auto_route.dart';
import 'package:flutter_bloc/flutter_bloc.dart';

/// Enter the SignIn documentation here
@RoutePage()
class SignInPage extends StatelessWidget with AutoRouteWrapper {

  /// The constructor of the page.
  const SignInPage({super.key});

  @override
  Widget wrappedRoute(BuildContext context) =>
      MultiBlocProvider(
        providers: [
          //TODO inject your BLoCs here
        ],
        child: this,
      );

  @override
  Widget build(BuildContext context) => Placeholder();
}

Stateful Page File (with AutoRoute)

import 'package:flutter/material.dart';
import 'package:auto_route/auto_route.dart';
import 'package:flutter_bloc/flutter_bloc.dart';

/// Enter the SignIn documentation here
@RoutePage()
class SignInPage extends StatefulWidget with AutoRouteWrapper {

  /// The constructor of the page.
  const SignInPage({super.key});

  @override
  Widget wrappedRoute(BuildContext context) =>
      MultiBlocProvider(
        providers: const [
          //TODO inject your BLoCs here
        ],
        child: this,
      );

  @override
  State<SignInPage> createState() => _SignInState();
}

class _SignInState extends State<SignInPage> {
  @override
  void initState() {
    super.initState();
  }

  @override
  void dispose() {
    super.dispose();
  }

  @override
  Widget build(BuildContext context) => Placeholder();
}

Test File

import 'package:pine/pine.dart';
import 'package:flutter/material.dart';
import 'package:{{package_name}}/pages/sign_in_page.dart';
import 'package:flutter_test/flutter_test.dart';

/// Test case for the page SignIn
void main() {
  setUp(() {});

  testWidgets('write your test description here', (tester) async {
    await tester.pumpWidget(
      const DependencyInjectorHelper(
        child: MaterialApp(
          home: SignInPage(),
        ),
      ),
    );

    //TODO: Pump your page, write your expectations, and verify invocations.
  });
}

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 pine_page

# Install globally
mason add -g pine_page

Usage 🚀

mason make pine_page

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: "^0.1.0"

0.3.0

Updated mason minimum version to ^0.1.0

0.2.1

Fixed missing auto_route import

0.2.0

Support to AutoRoute v6 and higher

0.1.0

First release

Copyright (c) 2024 MyLittleSuite

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.