MagicComment

by Egor Iskrenkov ALL

Fully customizable Sublime Text plugin that automatically inserts configured pragma comments for you

Labels text manipulation, ruby, frozen string

Details

Version 1.3.0
Homepage packagecontrol.io
Issues github.com
Modified 4 years ago
Last Seen 3 hours ago
First Seen 4 years ago

Installs

Total 248
Win 145
Mac 53
Linux 50

	Jan 31	Jan 30	Jan 29	Jan 28	Jan 27	Jan 26	Jan 25	Jan 24	Jan 23	Jan 22	Jan 21	Jan 20	Jan 19	Jan 18	Jan 17	Jan 16	Jan 15	Jan 14	Jan 13	Jan 12	Jan 11	Jan 10	Jan 9	Jan 8	Jan 7	Jan 6	Jan 5	Jan 4	Jan 3	Jan 2	Jan 1	Dec 31	Dec 30	Dec 29	Dec 28	Dec 27	Dec 26	Dec 25	Dec 24	Dec 23	Dec 22	Dec 21	Dec 20	Dec 19	Dec 18
Windows	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	0	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

MagicComment ✨ for Sublime Text

MagicComment is a fully customizable Sublime Text plugin that automatically inserts required magic comments for you

Development is motivated by frozen_string_literal comment for Ruby files, but plugin can be used for literally any kind of files and any strings that you want to automatically insert

Manual usage Demo

Screen Recording 2022-03-14 at 01 17 57

Installation

Package Control

MagicComment is available at Package Control. Just select Package Control: Install Package in Sublime command palette and search for MagicComment

Manual Installation

cd <Packages directory> (macOS: ~/Library/Application\ Support/Sublime\ Text/Packages)
git clone https://github.com/eiskrenkov/MagicComment.git

Usage

On file save - Enabled by default, can be disabled in settings
Key Bindings - Commented by default, can be configured to anything you want
Command Palette - CMD+P and type MagicComment (or just comment) and select MagicComment: Insert Comments

You can always configure key bindings at Sublime Text menu -> Preferences -> Package Settings -> MagicComment -> Key Bindings

Default Configuration

Remember, that you can always reconfigure it, just open Sublime Text menu -> Preferences -> Package Settings -> MagicComment -> Settings

General

run_on_save
- Type: Boolean
- Default: true

Comments

text - Text of the comment to insert
- Type: String
- Default: true
line - Number of the line you wish to insert the comment
- Type: Integer
- Default: 1
blank_lines - Amount of blank lines to insert after the comment
- Type: Integer
- Default: 0
files - Object, containing files specific settings
- Type: Object
files -> include - List of file names and extensions to insert comment for
- Type: Array of String
- Default: []
files -> exclude - List of file names and extensions that you want to ignore
- Type: Array of String
- Default: []

Note, that Include and Exclude arrays support wildcards for file extensions via '*'. E.g *.rb mathes all Ruby files, *.py - all Python files and so on

Example configuration for `#frozen_string_literal: true` for `.rb` files

{
    "text": "# frozen_string_literal: true",
    "line": 1,
    "blank_lines": 1,
    "files": {
        "include": ["*.rb", "Gemfile", "Rakefile", "config.ru"],
        "exclude": ["schema.rb"]
    }
}

Contribution

Issues and pull requests are highly welcome!

Magic​Comment