Giter VIP home page Giter VIP logo

cli's Introduction

Stacked CLI

The official CLI (Command Line Interface) dev tools for working with the Stacked framework. Stacked is a framework built in Flutter for production teams. It is built for maintenance, readability, and scaleability. To read about the usage of this tool read the Stacked CLI docs

Running the code

Todo: write out the steps to run this project locally

To test the updated executable code locally run

# If you're inside the stacked_cli folder use . otherwise use path to stacked_cli directory
dart pub global activate --source path .

Code Structure

Todo: Write out a code base overview to explain how things are built

Templates

Templates are written as normal dart files using mustache templating. A file that can be templated should end in .stk . All the constants that can be replaced in templates ca be found in lib/src/templates/template_constants.dart. The values we have to substitute at the moment is:

  • viewName: The name of the view class in dart. Given a name 'details' expects viewName to equal DetailsView

  • viewFolderName: The name of the folder that the view will be created in. This is a snake_case version of the name.

  • viewFileName: The name of the file that the view is created in with the dart extension. Given a name 'details' expects viewFileName to equal details_view.dart

  • viewModelName: The name of the viewmodel class in dart. Given a name 'details' expects viewModelName to equal DetailsViewModel

  • viewModelFileName: The name of the file that the viewmodel is created in with the dart extension. Given a name 'details' expects viewModelFileName to equal details_viewmodel.dart

  • packageName: The name of the package that the cli tool is running in. This is read from the pubspec.yaml file in the root folder.

  • serviceName: The name of the service class in Dart. Given a service name stripe expect StripeService

  • serviceFilename: The name of the file the service class will be stored in. Given a name stripe expect stripe_service.dart to be returned.

Todo: Change to a table and add all other template variables here

cli's People

Contributors

ferrarafer avatar semantic-release-bot avatar filledstacks avatar sebastianbuechler avatar renovate[bot] avatar buehler avatar n0mad-d3v avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.