Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename settings and the way settings are loaded #418

Closed
wants to merge 2 commits into from
Closed

Rename settings and the way settings are loaded #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7a379c
Fix settings; refactor the way settings are loaded
gerardroche Jan 30, 2016
5908b72
Fix Menu settings file paths
gerardroche Jun 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Default.sublime-keymap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
{ "keys": ["enter"], "command": "insert_snippet", "args": {"contents": "\n${TM_CURRENT_LINE/^\\s*((?:#|\\/\\/[\\/!]?)\\s*).*/$1/}"},
"context": [
{ "key": "setting.auto_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.jsdocs_extend_double_slash", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.docblockr.extend_double_slash", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selector", "operator": "equal", "operand": "comment.line", "match_all": true },
{ "key": "auto_complete_visible", "operator": "equal", "operand": false, "match_all": true },
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*(\\/\\/[\\/!]?|#)", "match_all": true }
Expand All @@ -89,7 +89,7 @@
{ "keys": ["keypad_enter"], "command": "insert_snippet", "args": {"contents": "\n${TM_CURRENT_LINE/^\\s*((?:#|\\/\\/[\\/!]?)\\s*).*$/$1/}"},
"context": [
{ "key": "setting.auto_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.jsdocs_extend_double_slash", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.docblockr.extend_double_slash", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selector", "operator": "equal", "operand": "comment.line", "match_all": true },
{ "key": "auto_complete_visible", "operator": "equal", "operand": false, "match_all": true },
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*\\/\\/[\\/!]?", "match_all": true }
Expand Down Expand Up @@ -150,7 +150,7 @@
{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
{ "key": "auto_complete_visible", "operator": "equal", "operand": false, "match_all": true },
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*\\/\\*{2}$", "match_all": true },
{ "key": "setting.jsdocs_quick_open_inline", "operator": "equal", "operand": true, "match_all": true}
{ "key": "setting.docblockr.quick_open_inline", "operator": "equal", "operand": true, "match_all": true}
]
},
// Open an inline docblock (/** */)
Expand Down Expand Up @@ -191,7 +191,7 @@
// indent to align with the previous line
{ "keys": ["tab"], "command": "jsdocs_indent",
"context": [
{ "key": "setting.jsdocs_deep_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.docblockr.deep_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.auto_indent", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
{ "key": "preceding_text", "operator": "regex_contains", "operand": "^\\s*\\*\\s*$", "match_all": true },
Expand All @@ -201,14 +201,14 @@
// decorate a double-slash comment
{ "keys": ["ctrl+enter"], "command": "jsdocs_decorate",
"context": [
{ "key": "setting.jsdocs_decorate", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.docblockr.decorate", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selector", "operator": "equal", "operand": "comment.line.double-slash", "match_all": true }
]
},
// decorate a double-slash comment
{ "keys": ["ctrl+keypad_enter"], "command": "jsdocs_decorate",
"context": [
{ "key": "setting.jsdocs_decorate", "operator": "equal", "operand": true, "match_all": true },
{ "key": "setting.docblockr.decorate", "operator": "equal", "operand": true, "match_all": true },
{ "key": "selector", "operator": "equal", "operand": "comment.line.double-slash", "match_all": true }
]
},
Expand Down
4 changes: 2 additions & 2 deletions Main.sublime-menu
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
"caption": "Settings – Default",
"command": "open_file", "args":
{
"file": "${packages}/DocBlockr/Base File.sublime-settings"
"file": "${packages}/DocBlockr/Preferences.sublime-settings"
}
},
{
"caption": "Settings – User",
"command": "open_file", "args":
{
"file": "${packages}/User/Base File.sublime-settings"
"file": "${packages}/User/Preferences.sublime-settings"
}
},
{
Expand Down
50 changes: 25 additions & 25 deletions Base File.sublime-settings → Preferences.sublime-settings
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
// If true, when in a docblock, pressing tab after a @tag line (like @param, @return)
// will indent to the description. This is useful if you are writing a long description
// and want that block of text to stay aligned.
"jsdocs_deep_indent": true,
"docblockr.deep_indent": true,

// If true, then pressing enter while in a double-slash comment (like this one)
// will automatically add two slashes to the next line as well
"jsdocs_extend_double_slash": true,
"docblockr.extend_double_slash": true,

// the number of spaces to add after the leading *
"jsdocs_indentation_spaces": 1,
"docblockr.indentation_spaces": 1,

// The number of spaces to add after the leading * in lines under the first line of each
// paragraph. This is only used together with automatic line wrapping. For example, a value
Expand All @@ -24,7 +24,7 @@
// * massa, sit amet adipiscing dolor.
// * @return {[Type]}
// */
"jsdocs_indentation_spaces_same_para": 1,
"docblockr.indentation_spaces_same_para": 1,

// whether the words following the @tags should align.
// Possible values are 'no', 'shallow', 'deep'
Expand All @@ -39,34 +39,34 @@
// @param {MyCustomClass} myVariable desc1
// @return {String} foo desc2
// @property {Number} blahblah desc3
"jsdocs_align_tags": "deep",
"docblockr.align_tags": "deep",

// Any additional boilerplate tags which should be added to each block. Should be an array of strings.
// Note that this only applies when a docblock is opened directly preceding a function.
// Tab points can be added by using snippet syntax, eg: ${1:default text}
"jsdocs_extra_tags": [],
"docblockr.extra_tags": [],

// If extra tags are defined, by default they go between the description and the param/return tags. If this is set to
// true, the extra tags are placed at the very end.
"jsdocs_extra_tags_go_after": false,
"docblockr.extra_tags_go_after": false,

// A map to determine the value of variables, should hungarian notation (or similar) be in use
"jsdocs_notation_map": [],
"docblockr.notation_map": [],

// Since there seems to be no agreed standard for "@return" or "@returns", use this setting to rename it as you wish.
"jsdocs_return_tag": "@return",
"docblockr.return_tag": "@return",

// Add a '[function_name description]' for the function block
"jsdocs_function_description": true,
"docblockr.function_description": true,

// Add a '[description]' placeholder for the return tag?
"jsdocs_return_description": true,
"docblockr.return_description": true,

// Add a '[description]' placeholder for the param tag?
"jsdocs_param_description": true,
"docblockr.param_description": true,

// Add a name of parameter in param tag?
"jsdocs_param_name": true,
"docblockr.param_name": true,

// Whether there should be blank lines added between the description line, and between tags of different types.
// Possible values are true, false, or "after_description".
Expand All @@ -91,11 +91,11 @@
// * @param {Number} bar
// * @return {[Type]}
// */
"jsdocs_spacer_between_sections": false,
"docblockr.spacer_between_sections": false,

// Whether each section should be indented to the same level, or indent each one individually.
// (When true, the @param section will lose the extra space immediately after each '@param').
"jsdocs_per_section_indent": false,
"docblockr.per_section_indent": false,

// Minimum spaces between cols (default is 1). For example, a value
// of 2 might look like this:
Expand All @@ -108,32 +108,32 @@
// *
// * @return {[Type]} description
// */
"jsdocs_min_spaces_between_columns": 1,
"docblockr.min_spaces_between_columns": 1,

// indicates whether the @method tag should be added automatically
"jsdocs_autoadd_method_tag": false,
"docblockr.autoadd_method_tag": false,

// If set to true, DocBlockr won't parse any code, providing no default templates. All other functions work as normal.
"jsdocs_simple_mode": false,
"docblockr.simple_mode": false,

// If set to true, primitives such as "Number" and "String" will be documented as "number" and "string".
"jsdocs_lower_case_primitives": false,
"docblockr.lower_case_primitives": false,

// If set to true, primitives such as "boolean" and "integer" will be shortened to "bool" and "int".
"jsdocs_short_primitives": false,
"docblockr.short_primitives": false,

// This property affects the default tag added to `var` declarations in Javascript/Coffeescript. If `false`, the
// default is used ("var"), otherwise it can be set to any String, eg: "property"
"jsdocs_override_js_var": false,
"docblockr.override_js_var": false,

// If set to true, an extra line break is added after the end of a docblock to separate it from the code.
"jsdocs_newline_after_block": false,
"docblockr.newline_after_block": false,

// If set to true, Ctrl+Enter while in a single line comment will 'decorate' the comment.
"jsdocs_decorate": true,
"docblockr.decorate": true,

// If set to true, typing /**<space> will open an inline docblock
"jsdocs_quick_open_inline": true,
"docblockr.quick_open_inline": true,

"jsdocs_development_mode": false
"docblockr.development_mode": false
}
Loading