October Code
October Code helps you with development of projects based on October CMS by providing many features, such as code completions, code generation, simplifies code navigation and more.
Features
For theme developers
- formatting of theme files
- completions of theme file names: layouts, pages, partials, content files
- twig completions: variables, tags, functions, filters including custom things defined in october plugins
- ini section completions: properties related to file type, components names and their properties
- partials and content variables completions in {% partial ... %} and {% content ... %} twig tags
- ajax methods of current file and used components in data-request html attribute and js request methods
- diagnostics of not existing theme files and quick fixes to create them
- extract partial code action
- code lenses for quickly find partials, content files and layouts usages
- and more...
For plugin developers
- configurable code generators for controllers, models, commands, migrations, widgets and more...
- yaml config validation and completions based on json schemas
- completions of model attributes, model classes, models scopes, model getFieldNameOptions, config path and partials path in yaml configs
- completions of permission codes, mail templates, validation rules, config and env keys
- simplified code navigation by go to model, go to controller and go to related file commands
- document links for partials, configs and model classes in yaml configs and php files
- and more...
Requirements
October Code requires redhat.vscode-yaml extension to be installed for validate and autocomplete yaml configs based on provided json schemas.
Prettier
OctoberCode uses Prettier under the hood for format markup files. OctoberCode have support for .prettierrc config files.
In addition to the basic Prettier settings, the following are supported
| Lang |
Option |
Default |
Description |
| ini |
iniSpaceAroundEquals |
true |
Adds a space around the equals sign when specifying params. |
| php |
phpVersion |
"7.2" |
Allows specifying the PHP version you're using. If you're using PHP 7.1 or later, setting this option will make use of modern language features in the printed output. If you're using PHP lower than 7.0, you'll have to set this option or Prettier will generate incompatible code. |
| php |
trailingCommaPHP |
true |
If set to true, trailing commas will be added wherever possible. If set to false, no trailing commas are printed. |
| php |
singleQuote |
true |
If set to true, strings that use double quotes but do not rely on the features they add, will be reformatted. Example: "foo" -> 'foo', "foo $bar" -> "foo $bar". |
| php |
braceStyle |
"per-cs" |
If set to "per-cs", prettier will move open brace for code blocks (classes, functions and methods) onto new line. If set to "1tbs", prettier will move open brace for code blocks (classes, functions and methods) onto same line. |
Configuring VS Code
For better file associations it is recommended to add following lines to your vscode config file:
"files.associations": {
"**/themes/**/*.htm": "october-tpl",
"**/plugins/**/components/**/*.htm": "october-tpl",
"**/plugins/**/views/**/*.htm": "october-tpl",
"**/plugins/**/controllers/**/*.htm": "php"
},
For better code folding ranges add this:
"[october-tpl]": {
"editor.defaultFoldingRangeProvider": "SergeyKasyanov.october-code"
}
For emmet to work in theme files, add this to config:
"emmet.includeLanguages": {
"october-tpl": "html"
},
If you use IntelliSense for CSS class names in HTML (Zignd.html-css-class-completion) add october-tpl to html-css-class-completion.HTMLLanguages
"html-css-class-completion.HTMLLanguages": [
...
"october-tpl"
],
For CSS Peek (pranaygp.vscode-css-peek) add october-tpl to cssPeek.peekFromLanguages
"cssPeek.peekFromLanguages": [
...
"october-tpl"
]
For Tailwind CSS IntelliSense (bradlc.vscode-tailwindcss) add this:
"tailwindCSS.includeLanguages": {
"october-tpl": "html"
},
Notice
October CMS name and logo belongs to Aleksey Bobkov and Sam Georges.
The extension uses some open source libraries. List of used libraries and their licenses can be found in NOTICE.md
