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 2 years ago
Last Seen 2 hours ago
First Seen 2 years ago

Installs

Total 184
Win 107
Mac 39
Linux 38

	Jul 27	Jul 26	Jul 25	Jul 24	Jul 23	Jul 22	Jul 21	Jul 20	Jul 19	Jul 18	Jul 17	Jul 16	Jul 15	Jul 14	Jul 13	Jul 12	Jul 11	Jul 10	Jul 9	Jul 8	Jul 7	Jul 6	Jul 5	Jul 4	Jul 3	Jul 2	Jul 1	Jun 30	Jun 29	Jun 28	Jun 27	Jun 26	Jun 25	Jun 24	Jun 23	Jun 22	Jun 21	Jun 20	Jun 19	Jun 18	Jun 17	Jun 16	Jun 15	Jun 14	Jun 13
Windows	0	0	0	0	0	0	0	0	0	1	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	1	0
Mac	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	0	0	0	0	0	0	0	0	0	0	0
Linux	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	1	0	0	0	0	0	1	1	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