Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
vanlooverenkoen committed Sep 18, 2019
0 parents commit dcae3d2
Show file tree
Hide file tree
Showing 81 changed files with 2,360 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.buildlog
.dart_tool/
.DS_Store
.idea
.pub/
.settings/
*.iml
**/build
**/packages
**/pubspec.lock
**/.packages
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## [0.0.1] - 2019-06-12
### Added
-Initial release
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 icapps

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.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# flutter icapps generator

A dart package to automaticly generate new code when creating a new screen.

[![pub package](https://img.shields.io/pub/v/icapps_generator.svg)](https://pub.dartlang.org/packages/icapps_generator)

This repo contains an example how to use this package.

Packages used:
- provider
- kiwi
- icapps_generator

## Setup

### Add dependency to pubspec

[![pub package](https://img.shields.io/pub/v/icapps_generator.svg)](https://pub.dartlang.org/packages/icapps_generator)
```
dev-dependencies:
icapps_generator: <latest-version>
```
### Run package with Flutter

```
flutter packages pub run icapps_generator your_screen_name
```

### Run package with Dart

```
pub run icapps_generator your_screen_name
```

### Result

Code will be generated:

- Screen
- ViewModel
- Add @Register.factory to the injector file
- Add code to make sure you can navigate to your new screen in the MainNavigatorWidget
- Generate the dependecy tree

### Working on mac?

add this to you .bash_profile

```
fluttergenerator(){
flutter packages pub run icapps_generator $1
}
```

now you can use the icapps generator with a single command.

```
fluttergenerator your_screen_name
```
129 changes: 129 additions & 0 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
analyzer:
errors:
missing_required_param: error
missing_return: error
todo: ignore
sdk_version_async_exported_from_core: ignore
exclude:
- '**.g.dart'

linter:
rules:
- always_put_required_named_parameters_first
- always_require_non_null_named_parameters
- annotate_overrides
- avoid_annotating_with_dynamic
- avoid_as
- avoid_bool_literals_in_conditional_expressions
- avoid_catching_errors
- avoid_double_and_int_checks
- avoid_empty_else
- avoid_field_initializers_in_const_classes
- avoid_implementing_value_types
- avoid_init_to_null
- avoid_js_rounded_ints
- avoid_null_checks_in_equality_operators
- avoid_positional_boolean_parameters
- avoid_private_typedef_functions
- avoid_relative_lib_imports
- avoid_renaming_method_parameters
- avoid_return_types_on_setters
- avoid_returning_null
- avoid_returning_null_for_future
- avoid_returning_null_for_void
- avoid_returning_this
- avoid_setters_without_getters
- avoid_shadowing_type_parameters
- avoid_single_cascade_in_expression_statements
- avoid_slow_async_io
- avoid_types_as_parameter_names
- avoid_types_on_closure_parameters
- avoid_unused_constructor_parameters
- avoid_void_async
- await_only_futures
- camel_case_types
- cancel_subscriptions
- cascade_invocations
- close_sinks
- comment_references
- control_flow_in_finally
- curly_braces_in_flow_control_structures
- directives_ordering
- empty_catches
- empty_constructor_bodies
- empty_statements
- file_names
- hash_and_equals
- implementation_imports
- invariant_booleans
- iterable_contains_unrelated_type
- join_return_with_assignment
- library_names
- library_prefixes
- list_remove_unrelated_type
- literal_only_boolean_expressions
- no_adjacent_strings_in_list
- no_duplicate_case_values
- non_constant_identifier_names
- null_closures
- omit_local_variable_types
- one_member_abstracts
- only_throw_errors
- overridden_fields
- package_api_docs
- package_names
- package_prefixed_library_names
- parameter_assignments
- prefer_adjacent_string_concatenation
- prefer_asserts_in_initializer_lists
- prefer_conditional_assignment
- prefer_const_constructors
- prefer_const_constructors_in_immutables
- prefer_const_declarations
- prefer_const_literals_to_create_immutables
- prefer_constructors_over_static_methods
- prefer_contains
- prefer_equal_for_default_values
- prefer_final_fields
- prefer_final_in_for_each
- prefer_final_locals
- prefer_foreach
- prefer_function_declarations_over_variables
- prefer_generic_function_type_aliases
- prefer_initializing_formals
- prefer_int_literals
- prefer_interpolation_to_compose_strings
- prefer_is_empty
- prefer_is_not_empty
- prefer_iterable_whereType
- prefer_null_aware_operators
- prefer_single_quotes
- prefer_typing_uninitialized_variables
- prefer_void_to_null
- recursive_getters
- slash_for_doc_comments
- sort_pub_dependencies
- test_types_in_equals
- throw_in_finally
- type_init_formals
- unawaited_futures
- unnecessary_await_in_return
- unnecessary_brace_in_string_interps
- unnecessary_const
- unnecessary_getters_setters
- unnecessary_lambdas
- unnecessary_new
- unnecessary_null_aware_assignments
- unnecessary_null_in_if_null_operators
- unnecessary_overrides
- unnecessary_parenthesis
- unnecessary_statements
- unnecessary_this
- unrelated_type_equality_checks
- use_full_hex_values_for_flutter_colors
- use_rethrow_when_possible
- use_setters_to_change_properties
- use_string_buffers
- use_to_and_as_if_applicable
- valid_regexps
- void_checks
Binary file added assets/example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 79 additions & 0 deletions bin/icapps_generator.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import 'dart:io';

import 'package:path/path.dart';

import 'src/file_creator_helper.dart';
import 'src/flutter_helper.dart';
import 'src/params.dart';

var screenName = '';
Params params;

Future<void> main(List<String> args) async {
final pubspecYaml = File(join(Directory.current.path, 'pubspec.yaml'));
if (!pubspecYaml.existsSync()) {
throw Exception('This program should be run from the root of a flutter/dart project');
}
if (args == null || args.isEmpty) {
throw Exception('No arguments provided. 1 argument is required.');
} else if (args.length > 1) {
throw Exception('${args.length} arguments are provided. Only 1 is allowed');
}
screenName = args[0];
if (screenName.isEmpty) {
print('Screenname is empty.');
return;
}

await parsePubspec(pubspecYaml);

print('Generating a new screen called `$screenName`');
createFolders();
createFiles();
await FileCreatorHelper.updateInjector(params.projectName, screenName);
await FileCreatorHelper.updateMainNavigator(params.projectName, screenName);
print('');
print('Generate Kiwi tree...');
await FlutterHelper.regenerateKiwi();
print('Done!!!');
}

Future<void> parsePubspec(File pubspecYaml) async {
final pubspecContent = pubspecYaml.readAsStringSync();
params = Params(pubspecContent);
}

void createFolders() {
final screensFolder = Directory(join('lib', 'screens', screenName));
if (!screensFolder.existsSync()) {
print('`lib/screens/${screenName}_screen` does not exists');
print('Creating folder...');
screensFolder.createSync(recursive: true);
}

final viewModelFolder = Directory(join('lib', 'viewmodels', screenName));
if (!viewModelFolder.existsSync()) {
print('`lib/viewmodels/${screenName}_screen` does not exists');
print('Creating folder...');
viewModelFolder.createSync(recursive: true);
}
}

void createFiles() {
final screenFile = File(join('lib', 'screens', screenName, '${screenName}_screen.dart'));
final viewModelFile = File(join('lib', 'viewmodels', screenName, '${screenName}_viewmodel.dart'));

if (screenFile.existsSync()) {
throw Exception('`lib/screens/${screenName}_screen.dart` already exists');
}
if (viewModelFile.existsSync()) {
throw Exception('`lib/viewmodels/${screenName}_viewmodel.dart` already exists');
}
print('Create `lib/screens/${screenName}_screen.dart`');
screenFile.createSync(recursive: true);
print('Create `lib/viewmodels/${screenName}_viewmodel.dart`');
viewModelFile.createSync(recursive: true);

FileCreatorHelper.createViewModelFile(screenName);
FileCreatorHelper.createScreenFile(params.projectName, screenName);
}
41 changes: 41 additions & 0 deletions bin/src/case_util.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
class CaseUtil {
static final RegExp _upperAlphaRegex = RegExp(r'[A-Z]');
static final RegExp _symbolRegex = RegExp(r'[ ./_\-]');

CaseUtil._();

static String getCamelcase(String string) {
final wordsGroup = _groupIntoWords(string);
return wordsGroup.map(_upperCaseFirstLetter).toList().join('');
}

static List<String> _groupIntoWords(String text) {
final sb = StringBuffer();
final words = List<String>();
final isAllCaps = !text.contains(RegExp('[a-z]'));

for (var i = 0; i < text.length; i++) {
final char = String.fromCharCode(text.codeUnitAt(i));
final nextChar = text.length == i + 1 ? null : String.fromCharCode(text.codeUnitAt(i + 1));

if (_symbolRegex.hasMatch(char)) {
continue;
}

sb.write(char);

final isEndOfWord = nextChar == null || (_upperAlphaRegex.hasMatch(nextChar) && !isAllCaps) || _symbolRegex.hasMatch(nextChar);

if (isEndOfWord) {
words.add(sb.toString());
sb.clear();
}
}

return words;
}

static String _upperCaseFirstLetter(String word) {
return '${word.substring(0, 1).toUpperCase()}${word.substring(1).toLowerCase()}';
}
}
Loading

0 comments on commit dcae3d2

Please sign in to comment.