Skip to content

Instantly share code, notes, and snippets.

@leompeters
Last active December 17, 2018 16:41
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save leompeters/dd6574b4321ae5b47f48 to your computer and use it in GitHub Desktop.
Save leompeters/dd6574b4321ae5b47f48 to your computer and use it in GitHub Desktop.
Atom editor settings for Belanton Team.
Atom editor settings for Belanton Team.
You can use these settings on your Atom editor [http://atom.io] copy. Here are
defaults Atom config files (config.cson, init.coffee, keymap.cson, snippets.cson and
styles.less) and Project Manager package list [http://atom.io/packages/project-manager].
# Your configurations
#
# Most of Atom configurations are defined by Preferences item on Atom menu {cmd-,}.
# Some pacakges use this file o setup its features.
"*":
"atom-beautify":
general:
_analyticsUserId: "d09af7bc-9e26-4bc9-a00b-265eeacc9071"
core:
disabledPackages: [
"linter-codeclimate"
]
projectHome: "/Users/leomperes/Workspace"
editor:
backUpBeforeSaving: true
# "preferredLineLength": 90
fontSize: 12
invisibles: {}
showIndentGuide: true
softWrap: true
tabLength: 4
"exception-reporting":
userId: "5087b60a-0a73-217f-2172-9433a91dc13b"
"file-icons":
forceShow: true
"highlight-column":
opacity: 0.05
"highlight-line":
enableSelectionBorder: true
"auto-copyright":
"owner": "Belanton, Inc"
"template": """
Author:: Leo M. Peres <mailto:leomperes@belanton.com>
Copyright:: Copyright (c) %y by %o. All Rights Reserved.
License:: Licensed under the MIT license
<www.opensource.org/licenses/mit-license.php>
"""
# 'minimap':
# 'autoToggle': true
# 'recent-files':
# 'updated': false
linter:
errorPanelHeight: 91
"markdown-preview":
useGitHubStyle: true
"project-manager":
closeCurrent: true
wakatime:
apikey: "74b18751-d119-4512-84ad-53286f9ddba3"
"wakatime-hidden":
lastInit: 1465422689
welcome:
showOnStartup: false
".diff.source":
editor:
tabLength: 4
# Your init script
#
# Atom will evaluate this file each time a new window is opened. It is run
# after packages are loaded/activated and after the previous editor state
# has been restored.
#
# An example hack to make opened Markdown files always be soft wrapped:
#
# path = require 'path'
#
# atom.workspaceView.eachEditorView (editorView) ->
# editor = editorView.getEditor()
# if path.extname(editor.getPath()) is '.md'
# editor.setSoftWrap(true)
atom.commands.dispatch(
atom.views.getView(atom.workspace),
'editor-stats:toggle'
)
'.editor':
'alt-shift-I': 'auto-copyright:insert'
'.workspace .editor:not(.mini)':
'ctrl-alt-shift-s': 'editor-stats:toggle'
# 'alt-shift-up': 'editor:add-selection-above'
# 'alt-shift-down': 'editor:add-selection-below'
'.autocomplete-plus input.hidden-input':
'enter': 'autocomplete-plus:confirm'
# '.platform-darwin':
# 'ctrl-cmd-s': 'project-manager:save-project'
# 'ctrl-cmd-e': 'project-manager:edit-projects'
# 'ctrl-cmd-r': 'project-manager:reload-project-settings'
'atom-workspace, atom-workspace atom-text-editor':
'ctrl-shift-A b': 'api-blueprint-preview:toggle'
'platform-win32':
'ctrl-alt-p': 'project-manager:list-projects'
'body':
'ctrl-alt-shift-down': 'editor:add-selection-below'
'ctrl-alt-shift-up': 'editor:add-selection-above'
# Your keymap
#
# Atom keymaps work similarly to style sheets. Just as style sheets use
# selectors to apply styles to elements, Atom keymaps use selectors to associate
# keystrokes with events in specific contexts. Unlike style sheets however,
# each selector can only be declared once.
#
# You can create a new keybinding in this file by typing "key" and then hitting
# tab.
#
# Here's an example taken from Atom's built-in keymap:
#
# 'atom-text-editor':
# 'enter': 'editor:newline'
#
# 'atom-workspace':
# 'ctrl-shift-p': 'core:move-up'
# 'ctrl-p': 'core:move-down'
#
# You can find more information about keymaps in these guides:
# * http://flight-manual.atom.io/using-atom/sections/basic-customization/#customizing-keybindings
# * http://flight-manual.atom.io/behind-atom/sections/keymaps-in-depth/
#
# If you're having trouble with your keybindings not working, try the
# Keybinding Resolver: `Cmd+.` on macOS and `Ctrl+.` on other platforms. See the
# Debugging Guide for more information:
# * http://flight-manual.atom.io/hacking-atom/sections/debugging/#check-the-keybindings
#
# This file uses CoffeeScript Object Notation (CSON).
# If you are unfamiliar with CSON, you can read more about it in the
# Atom Flight Manual:
# http://flight-manual.atom.io/using-atom/sections/basic-customization/#configuring-with-cson
'body':
# 'ctrl-shift-T': 'pane:reopen-closed-item'
'cmd-home': 'core:move-to-top'
'cmd-end': 'core:move-to-bottom'
'shift-cmd-home': 'core:select-to-top'
'shift-cmd-end': 'core:select-to-bottom'
'.editor':
'shift-cmd-I': 'auto-copyright:insert'
'.workspace .editor:not(.mini)':
'alt-shift-up': 'editor:add-selection-above'
'alt-shift-down': 'editor:add-selection-below'
# Editor Stats
'ctrl-shift-s': 'editor-stats:toggle'
'.autocomplete-plus input.hidden-input':
'enter': 'autocomplete-plus:confirm'
'.platform-darwin':
# Project Manager
'ctrl-cmd-s': 'project-manager:save-project'
'ctrl-shift-cmd-d': 'project-manager:edit-project'
'ctrl-cmd-d': 'project-manager:edit-projects'
'ctrl-cmd-l': 'project-manager:reload-project-settings'
# Git Plus
'shift-cmd-C a': 'git-plus:commit-all'
'shift-cmd-A x': 'git-plus:push'
'shift-cmd-A l': 'git-plus:pull'
'ctrl-v': 'git-plus:pull'
'.platform-darwin atom-workspace':
'alt-f12': 'platformio-ide-terminal:focus'
'shift-cmd-T': 'unset!'
# 'shift-cmd-T': 'platformio-ide-terminal:new'
# 'shift-ctrl-T': 'platformio-ide-terminal:new'
'ctrl-option-shift-T': 'platformio-ide-terminal:new'
'atom-workspace, atom-workspace atom-text-editor':
'cmd-m': 'minimap:toggle'
# Markdown
'ctrl-alt-m': 'markdown-preview:toggle'
# API Blueprint
'ctrl-alt-a': 'api-blueprint-preview:toggle'
# Your projects
#
# @see https://atom.io/packages/project-manager
#
# Here"s an example taken from Atom"s built-in keymap:
#
# [
# {
# title: "Project Manager"
# group: "Project Manager"
# paths: [
# "/path/to/project-manager"
# ]
# icon: "icon-squirrel"
# settings:
# setSoftWrap: true # Enable or disable soft wrap for this editor.
# setTabLength: 2 # Set the on-screen length of tab characters.
# }
# ]
[
{
title: "Belanton.com"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/belanton.com"
]
icon: "icon-globe"
settings:
setSoftTabs: true
setTabLength: 2
}
{
title: "belanton.github.io"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/belanton.github.io"
]
icon: "icon-mark-github"
}
{
title: "BlackSunDistribution"
group: "Chosen"
paths: [
"/Users/leomperes/Dropbox/Professional/Belanton/Clients/ChosenVitamins/Wholesale-master"
]
icon: "icon-package"
}
{
title: "ProXStock"
group: "Chosen"
paths: [
"/Users/leomperes/Dropbox/Professional/Belanton/Clients/ChosenVitamins/Stock-master"
]
icon: "icon-database"
}
{
title: "OhMyShake.com"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/OhMyShake/ohmyshake.com"
]
icon: "icon-light-bulb"
}
{
title: "Reino"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/Leconni/reino"
]
icon: "icon-light-bulb"
}
{
title: "LeonardoMarques.com.br"
group: "LeoMperes"
paths: [
"/Users/leomperes/Workspace/LeonardoMarques/leonardomarques.com.br"
]
icon: "icon-person"
}
{
title: "LeonardoMarques.github.io"
group: "LeoMperes"
paths: [
"/Users/leomperes/Workspace/LeonardoMarques/leonardomarques.github.io"
]
icon: "icon-mark-github"
}
{
title: "D1.System"
group: "D1 Corp"
paths: [
"/Users/leomperes/Workspace/D1Corp/d1corp.com"
]
icon: "icon-organization"
}
{
title: "MeyrexGroup.com"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/MeyrexGroup/meyrexgroup.com"
]
icon: "icon-pin"
}
{
title: "MeyrexGroup.github.io"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/Belanton/MeyrexGroup/meyrexgroup.github.io"
]
icon: "icon-mark-github"
}
{
title: "Bootstrap"
group: "LeoMperes"
paths: [
"/Users/leomperes/Google Drive/Team/development/TEMPLATES/twitter-bootstrap-v2.3.2"
]
icon: "icon-color-mode"
}
{
title: "TikTak"
group: "LeoMperes"
paths: [
"/Users/leomperes/Google Drive/Team/development/TEMPLATES/TikTak"
]
icon: "icon-history"
}
{
title: "iDesign"
group: "LeoMperes"
paths: [
"/Users/leomperes/Google Drive/Team/development/TEMPLATES/iDesign"
]
icon: "icon-color-mode"
}
{
title: "Create Muse"
paths: [
"/Users/leomperes/Dropbox/Professional/Belanton/development/TEMPLATES/create-muse-template"
]
icon: "icon-color-mode"
}
{
title: "Arcus"
group: "LeoMperes"
paths: [
"/Users/leomperes/Google Drive/Team/development/TEMPLATES/Arcus"
]
icon: "icon-color-mode"
}
{
title: "Belanton.Codes"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/LeonardoMarques/Codes"
]
icon: "icon-file-code"
}
{
title: "Belanton Atom Settings"
group: "Belanton"
paths: [
"/Users/leomperes/Workspace/LeonardoMarques/Codes/Settings/belanton_atom_settings"
]
icon: "icon-settings"
}
{
title: "Google Drive"
group: "LeoMperes"
paths: [
"/Users/leomperes/Google Drive"
]
icon: "icon-cloud-upload"
}
]
# Your snippets
#
# Atom snippets allow you to enter a simple prefix in the editor and hit tab to
# expand the prefix into a larger code block with templated values.
#
# You can create a new snippet in this file by typing "snip" and then hitting
# tab.
#
# An example CoffeeScript snippet to expand log to console.log:
#
# '.source.coffee':
# 'Console log':
# 'prefix': 'log'
# 'body': 'console.log $1'
#
'.text.html':
'Comment with style class':
'prefix': 'commc'
'body': '<!--/.$1-->'
'Comment with style ID':
'prefix': 'commi'
'body': '<!--/#$1-->'
# 'Script':
# 'prefix': 'script'
# 'body': '<script src="$1"></script>'
'.source.ruby':
'Commented module in RDoc':
'prefix': 'modc'
'body': """
\# :category: Business Module
\#
\# Document the responsibility of the module...
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module ${1:Namespace} \# :doc:
\# :category: Exception Class
\#
\# Generic Namespace exception class.
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# For example due to improper usage of column that +inheritance_column+ points to.
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
class NamespaceError < StandardError \# :doc:
end
\# :category: Exception Class
\#
\# Raised when...
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# For example due to improper usage of column that +inheritance_column+ points to.
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
class SpecificError < NamespaceError \# :doc:
end
$0
end
"""
'Commented Active Record module in RDoc':
'prefix': 'armc'
'body': """
\# :category: Data Module
\#
\# Document the responsibility of the module...
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module ${1:Namespace} \# :doc:
\# :category: Exception Class
\#
\# Generic Active Record exception class.
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# For example due to improper usage of column that +inheritance_column+ points to.
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
class ActiveRecordError < StandardError \# :doc:
end
\# :category: Exception Class
\#
\# Raised when the single-table inheritance mechanism failes to locate the subclass.
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# For example due to improper usage of column that +inheritance_column+ points to.
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
class SubclassNotFound < ActiveRecordError \# :doc:
end
$0
end
"""
'Commented module concern in RDoc':
'prefix': 'conc'
'body': """
\# :category: Concern/Service Module
\#
\# Document the responsibility of the module...
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module ${1:Module} \# :doc:
extend ActiveSupport::Concern
\# :category: Included Scopes
included do
# :singleton-method:
# Get Objects with ...
scope :scope_name,-> { where field_name: 1 }
end
\# :category: Included Module
\#
\# This module join all Class methods related to their Related Classes
\# (rdoc-ref:Namespace1::Class1 and rdoc-ref:Namespace2::Class2) information.
\#
\# Base Module:: Namespace::Class::Module
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module ClassMethods \# :doc:
$0
end
\# :category: Included Module
\#
\# This module join all Instance methods related to their Related Classes
\# (rdoc-ref:Namespace1::Class1 and rdoc-ref:Namespace2::Class2) information.
\#
\# Base Module:: Namespace::Class::Module
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module InstanceMethods \# :doc:
end
\# This module join all Files methods related to Profiles information.
\#
\# ===== Arguments
\#
\# 1. <tt>*receiver*</tt> - Base class that will use these module's methods.
\#
\# ===== Related Links
\#
\# * Namespace::Class::Module::ClassMethods
\# * Namespace::Class::Module::InstanceMethods
\#
def self.included(receiver) \# :doc:
receiver.extend ClassMethods
receiver.send :include, InstanceMethods
end
end
"""
'Commented included class methods concern in RDoc':
'prefix': 'clmc'
'body': """
\# :category: Included Module
\#
\# This module join all Class methods related to their Related Classes
\# (rdoc-ref:Namespace1::Class1 and rdoc-ref:Namespace2::Class2) information.
\#
\# Base Module:: Namespace::Class::Module
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module ClassMethods \# :doc:
\# Desribe the behaviour of the method...
\#
\# ===== Arguments
\#
\# 1. <tt>*param1*</tt> - The id of the object you wish to update a counter on.
\# 2. <tt><b>param 2</b></tt> - An Array of Hashes containing the names of the fields to update
\# as keys and the amount to update the field by as values.
\# 3. <tt>*options*</tt> - Document the third attribute below.
\# * +:conditions+ - An SQL fragment like "administrator = 1"
\# * +:order+ - An SQL fragment like "created_at DESC, name".
\# * +:group+ - An attribute name by which the result should be grouped
\# * +:limit+ - An integer determining the limit on the number of rows that should be returned.
\# * +:offset+ - An integer determining the offset from where the rows should be fetched.
\# * +:joins+ - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed)
\#
\# ===== Returns
\#
\# * <tt>*param*</tt> - The total number of ... as an +integer+.
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# # For the Post with id of 5, decrement the comments_count by 1, and
\# # increment the actions_count by 1
\# Post.update_counters 5, comments_count: -1, actions_count: 1
\# # Executes the following SQL:
\# # UPDATE posts
\# # SET comments_count = comments_count - 1,
\# # actions_count = actions_count + 1
\# # WHERE id = 5
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com> at %dtm_modified%
\#
def ${1:method_name} \# :doc:
$0
end
end
"""
'Commented included instance methods concern in RDoc':
'prefix': 'inmc'
'body': """
\# :category: Included Module
\#
\# This module join all Instance methods related to their Related Classes
\# (rdoc-ref:Namespace1::Class1 and rdoc-ref:Namespace2::Class2) information.
\#
\# Base Module:: Namespace::Class::Module
\# Base Class:: Namespace::Class
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
module InstanceMethods \# :doc:
\# Desribe the behaviour of the method...
\#
\# ===== Arguments
\#
\# 1. <tt>*param1*</tt> - The id of the object you wish to update a counter on.
\# 2. <tt><b>param 2</b></tt> - An Array of Hashes containing the names of the fields to update
\# as keys and the amount to update the field by as values.
\# 3. <tt>*options*</tt> - Document the third attribute below.
\# * +:conditions+ - An SQL fragment like "administrator = 1"
\# * +:order+ - An SQL fragment like "created_at DESC, name".
\# * +:group+ - An attribute name by which the result should be grouped
\# * +:limit+ - An integer determining the limit on the number of rows that should be returned.
\# * +:offset+ - An integer determining the offset from where the rows should be fetched.
\# * +:joins+ - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed)
\#
\# ===== Returns
\#
\# * <tt>*param*</tt> - The total number of ... as an +integer+.
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# # For the Post with id of 5, decrement the comments_count by 1, and
\# # increment the actions_count by 1
\# Post.update_counters 5, comments_count: -1, actions_count: 1
\# # Executes the following SQL:
\# # UPDATE posts
\# # SET comments_count = comments_count - 1,
\# # actions_count = actions_count + 1
\# # WHERE id = 5
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com> at %dtm_modified%
\#
def ${1:method_name} \# :doc:
$0
end
end
"""
'Commented included scopes concern in RDoc':
'prefix': 'scmc'
'body': """
\# :category: Included Scopes
included do
# :singleton-method:
# Get Objects with ...
scope :${1:method_name}, -> { where $0 }
end
"""
'Commented class in RDoc':
'prefix': 'clac'
'body': """
\# :category: Business Class
\#
\# Document the responsibility of the class...
\#
\# Base Module:: rdoc-ref:Namespace
\# Base Class:: Namespace::Class
\#
\# ===== Examples
\#
\# Illustrate the behaviour of the class using examples. Indent examples:
\#
\# base = Base.new("Example String")
\# base.method_name("Example", "more")
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com>
\# Copyright:: Copyright (c) %y by %o. All Rights Reserved.
\# License:: Licensed under the MIT license [www.opensource.org/licenses/mit-license.php]
\#
def ${1:class_name} \# :doc:
\# RDOC documents constants as well
MAX_NUMBER_OF_BOOKINGS = 3
\# Write comments above for accessors, this will be presented as [R/W]
attr_accessor :first_name
\# However this one will be presented as [R].
attr_reader :name
\# Read only attributes. Generally used for counter cache.
\# attr_readonly :associations_count, ...
\# Model associations.
belongs_to :association_name, class_name: 'Namespace::Class', counter_cache: :classes_count
has_many :association_name, -> { order :field_name }, dependent: :destroy,
through: :othoer_association_name, class_name: 'Namespace::Class'
accepts_nested_attributes_for :association_name, allow_destroy: true,
reject_if: lambda { |i| i[:field1_name].blank? && i[:field2_name].blank? }
\# Related gems and API's settings.
\# has_paper_trail
\# Model validations.
\# validates :user_id, presence: true
\# Model callbacks.
\# before_initialize :method_name
\# before_save :method_name
\# after_initialize :method_name
\# after_save :method_name
\# Model concerns inclusions.
include ModelConcernable
\# Remember the letters in the initial word...
def initialize(attributes = {}) # :notnew: stops RDoc from seeing the initialize method as the new method.
\# @name = attributes[:name]
\# @email = attributes[:email]
$0
end
\# Private methods if applicable.
private
end
"""
'Commented method in RDoc':
'prefix': 'defc'
'body': """
\# Desribe the behaviour of the method...
\#
\# ===== Arguments
\#
\# 1. <tt>*param1*</tt> - The id of the object you wish to update a counter on.
\# 2. <tt><b>param 2</b></tt> - An Array of Hashes containing the names of the fields to update
\# as keys and the amount to update the field by as values.
\# 3. <tt>*options*</tt> - Document the third attribute below.
\# * +:conditions+ - An SQL fragment like "administrator = 1"
\# * +:order+ - An SQL fragment like "created_at DESC, name".
\# * +:group+ - An attribute name by which the result should be grouped
\# * +:limit+ - An integer determining the limit on the number of rows that should be returned.
\# * +:offset+ - An integer determining the offset from where the rows should be fetched.
\# * +:joins+ - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed)
\#
\# ===== Returns
\#
\# * <tt>*param*</tt> - The total number of ... as an +integer+.
\#
\# ===== Raises
\#
\# * <tt>*ArgumentError*</tt> - List of ... +ExceptionErrors+.
\#
\# ===== Examples
\#
\# # For the Post with id of 5, decrement the comments_count by 1, and
\# # increment the actions_count by 1
\# Post.update_counters 5, comments_count: -1, actions_count: 1
\# # Executes the following SQL:
\# # UPDATE posts
\# # SET comments_count = comments_count - 1,
\# # actions_count = actions_count + 1
\# # WHERE id = 5
\#
\# ===== Related Links
\#
\# * Namespace::Class
\# * Namespace::Class#single_word_instance_method
\# * Namespace::Class::single_word_class_method
\# * Namespace::Class@Heading1
\# * Namespace::Class#single_word_instance_method@Heading1
\# * Namespace::Class::single_word_class_method@Heading+With+Multiple+Words
\#
\# Author:: Leo M. Peters <mailto:leompeters@belanton.com> at %dtm_modified%
\#
def ${1:method_name} \# :doc:
$0
end
"""
'Comment for rake notes:fixme':
'prefix': 'rnfixme'
'body': """
\#--
\# FIXME: Fails if the birthday falls on February 29th. High priority for next deploy.
\#++
"""
'Comment for rake notes:todo':
'prefix': 'rntodo'
'body': """
\#--
\# TODO: Any other way to do this\?
\#++
"""
'Comment for rake notes:optimize':
'prefix': 'rnoptimize'
'body': """
\#--
\# OPTIMIZE: Refactor this code to make it faster.
\#++
"""
/*
* Your Stylesheet
*
* This stylesheet is loaded when Atom starts up and is reloaded automatically
* when it is changed and saved.
*
* Add your own CSS or Less to fully customize Atom.
* If you are unfamiliar with Less, you can read more about it here:
* http://lesscss.org
*/
/*
* Examples
* (To see them, uncomment and save)
*/
// style the background color of the tree view
.tree-view {
// background-color: whitesmoke;
}
// style the background and foreground colors on the atom-text-editor-element itself
atom-text-editor {
// color: white;
// background-color: hsl(180, 24%, 12%);
}
// To style other content in the text editor's shadow DOM, use the ::shadow expression
atom-text-editor::shadow .cursor {
// border-color: red;
}
atom-text-editor.editor .line-number.foldable .icon-right {
visibility: visible;
}
// atom-text-editor atom-text-editor-minimap {
// background: green;
// }
atom-text-editor atom-text-editor-minimap .minimap-visible-area::after {
// background-color: rgba(255, 255, 0, 0.08);
border: 1px solid rgba(255, 255, 0, 0.5);
}
atom-text-editor atom-text-editor-minimap .minimap-scroll-indicator {
background-color: rgba(255, 255, 0, 0.5);
}
.editor-stats-wrapper {
// padding: 2px;
// padding-left: 0px;
// padding-bottom: 0px;
}
.git-plus.info-view {
padding-right: 6px;
pre {
border: 1px solid #181a1f;
border-radius: 0;
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment