0.5.1

Author: frarees

.editorconfig

@@ -1,8 +1,206 @@
-[*.cs]
+[package.json]
+indent_style = space
+indent_size = 2
+insert_final_newline = false
+charset = utf-8
 
+[*.cs]
+# Indentation and spacing
 indent_size = 4
 indent_style = space
 tab_width = 4
+
+# New line preferences
 end_of_line = lf
 insert_final_newline = true
 
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = false
+file_header_template = unset
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false:silent
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_property = false:silent
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+
+# Expression-level preferences
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_compound_assignment = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
+dotnet_style_prefer_simplified_interpolation = true:suggestion
+
+# Field preferences
+dotnet_style_readonly_field = true:suggestion
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = all:suggestion
+
+# Suppression preferences
+dotnet_remove_unnecessary_suppression_exclusions = none
+
+#### C# Coding Conventions ####
+
+# var preferences
+csharp_style_var_elsewhere = false:silent
+csharp_style_var_for_built_in_types = false:silent
+csharp_style_var_when_type_is_apparent = false:silent
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_prefer_not_pattern = true:suggestion
+csharp_style_prefer_pattern_matching = true:silent
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Modifier preferences
+csharp_prefer_static_local_function = true:suggestion
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:silent
+
+# Code-block preferences
+csharp_prefer_braces = true:silent
+csharp_prefer_simple_using_statement = true:suggestion
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_prefer_index_operator = true:suggestion
+csharp_style_prefer_range_operator = true:suggestion
+csharp_style_throw_expression = true:suggestion
+csharp_style_unused_value_assignment_preference = discard_variable:suggestion
+csharp_style_unused_value_expression_statement_preference = discard_variable:silent
+
+# 'using' directive preferences
+csharp_using_directive_placement = inside_namespace:silent
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = true
+csharp_new_line_before_else = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = all
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_labels = one_less_than_current
+csharp_indent_switch_labels = true
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers =
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers =
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers =
+
+# Naming styles
+
+dotnet_naming_style.pascal_case.required_prefix =
+dotnet_naming_style.pascal_case.required_suffix =
+dotnet_naming_style.pascal_case.word_separator =
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix =
+dotnet_naming_style.begins_with_i.word_separator =
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+

.github/CONTRIBUTING.md

@@ -6,3 +6,11 @@ Pull requests are welcome.
 
 Stick to the defined [EditorConfig](../.editorconfig) rules.
 
+# Development environment
+
+1. Open a Unity project – it can be a new one or an existing one.
+2. Clone this repository in the `Packages/` directory.
+3. Get focus back to Unity, and open the [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html). [Change the scope](https://docs.unity3d.com/Manual/upm-ui-filter.html) to In Project.
+4. You should see Easy Editor listed, tagged as `In Development`.
+5. In the [project window](https://docs.unity3d.com/Manual/ProjectView.html), navigate to `Packages/Easy Editor`. You can find all this project's files there.
+

README.md .github/README.mdREADME.md renamed to .github/README.md

@@ -1,14 +1,16 @@
 # Easy Editor
 
-Unity package to automate external code editor integrations:
+Unity package to automate external text editor integrations:
 
 - List compatible installed editors.
 - Per editor settings.
 - Project files (re)generation.
 
 ## Installation
 
-1. Install via [git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html):
+Install via [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html). There are several flavours:
+
+1. [git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html):
 
 ```
 https://github.com/frarees/easyeditor.git
@@ -20,21 +22,21 @@ Alternatively, you can install a specific version:
 https://github.com/frarees/easyeditor.git#v0.5.0
 ```
 
-2. Install via [local tarball](https://docs.unity3d.com/Manual/upm-ui-tarball.html):
+2. [Local tarball](https://docs.unity3d.com/Manual/upm-ui-tarball.html):
 
 Each [release](https://github.com/frarees/easyeditor/releases) includes a tarball named `com.frarees.easyeditor-<version>.tgz`.
 
-3. Install via [local folder](https://docs.unity3d.com/Manual/upm-ui-local.html):
+3. [Local folder](https://docs.unity3d.com/Manual/upm-ui-local.html):
 
-Download the repository contents and point Unity to the `package.json` file.
+Download the repository contents and point Unity Package Manager to the `package.json` file.
 
 You can download the repository as a compressed file for a specific [tag](https://github.com/frarees/easyeditor/tags).
 
 ## Usage
 
 Select your favourite [external script editor](https://docs.unity3d.com/Manual/Preferences.html#External-Tools) in Unity. You will get specific settings per editor. The rest is taken care of.
 
-![Preferences window](Documentation~/prefs.png)
+![Preferences window](images/prefs.png)
 
 ## Supported editors
 
@@ -47,9 +49,13 @@ Select your favourite [external script editor](https://docs.unity3d.com/Manual/P
 
 _gVim versions 8.1 and 8.2._
 
-Is there an editor you miss on this list? [Ask for it](https://github.com/frarees/easyeditor/issues/new?assignees=frarees&labels=enhancement&template=feature_request.md&title=) or [contribute](.github/CONTRIBUTING.md) your implementation.
+Is there an editor you miss on this list? [Ask for it](https://github.com/frarees/easyeditor/issues/new?assignees=frarees&labels=enhancement&template=feature_request.md&title=) or [contribute](CONTRIBUTING.md) your implementation.
+
+## Limitations
+
+Text editor executables are currently searched in their default installation paths.
 
 ## Contributing
 
-See [contributing](.github/CONTRIBUTING.md) and the [code of conduct](.github/CODE_OF_CONDUCT.md).
+See [contributing](CONTRIBUTING.md) and the [code of conduct](CODE_OF_CONDUCT.md).
 

Documentation~/prefs.png .github/images/prefs.pngDocumentation~/prefs.png renamed to .github/images/prefs.png

@@ -0,0 +1,4 @@
+.github
+.gitignore
+.editorconfig
+

.npmignore

@@ -1,13 +1,23 @@
 # Changelog
 
+## [0.5.1] - 2020-10-12
+
+### Added
+- Notes on limitations.
+- Notes on setting up a development environment.
+- `package.json` EditorConfig rules.
+- .NET EditorConfig rules.
+
+### Changed
+- Don't include the README in the package.
+
 ## [0.5.0] - 2020-10-06
 
 ### Added
 - Support for VimR on macOS.
 - Setting class to define launcher settings.
 - Unregister Easy Editor before the assembly reloads.
 - Documentation.
-- Package Publishing to GitHub.
 
 ### Changed
 - Launchers inherit from abstract class (Launcher) instead of interface (ILauncher).
@@ -75,6 +85,8 @@
 - Support for MacVim on macOS.
 - Support for Sublime Text 3 on macOS.
 
+[Unreleased]: https://github.com/frarees/easyeditor/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/frarees/easyeditor/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/frarees/easyeditor/compare/v0.4.3...v0.5.0
 [0.4.3]: https://github.com/frarees/easyeditor/compare/v0.4.2...v0.4.3
 [0.4.2]: https://github.com/frarees/easyeditor/compare/v0.4.1...v0.4.2

CHANGELOG.md

@@ -1,12 +1,12 @@
 {
   "name": "com.frarees.easyeditor",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "displayName": "Easy Editor",
   "description": "Support external editors with ease.",
   "unity": "2019.2",
-  "documentationUrl": "https://github.com/frarees/easyeditor/blob/v0.5.0/README.md",
-  "changelogUrl": "https://github.com/frarees/easyeditor/blob/v0.5.0/CHANGELOG.md",
-  "licensesUrl": "https://github.com/frarees/easyeditor/blob/v0.5.0/LICENSE.md",
+  "documentationUrl": "https://github.com/frarees/easyeditor/tree/v0.5.1",
+  "changelogUrl": "https://github.com/frarees/easyeditor/blob/v0.5.1/CHANGELOG.md",
+  "licensesUrl": "https://github.com/frarees/easyeditor/blob/v0.5.1/LICENSE.md",
   "keywords": [
     "editor"
   ],
@@ -16,4 +16,3 @@
     "url": "https://frarees.github.io"
   }
 }
-