settings.py

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-

# These lines allow to use UTF-8 encoding and run this file with `./update.py`, instead of `python update.py`
# https://stackoverflow.com/questions/7670303/purpose-of-usr-bin-python3
# https://stackoverflow.com/questions/728891/correct-way-to-define-python-source-code-encoding
#
#

#
# Licensing
#
# Amxx Channel Settings, all the settings required by this channel
# Copyright (C) 2017 Evandro Coan <https://github.com/evandrocoan>
#
#  This program is free software; you can redistribute it and/or modify it
#  under the terms of the GNU General Public License as published by the
#  Free Software Foundation; either version 3 of the License, or ( at
#  your option ) any later version.
#
#  This program is distributed in the hope that it will be useful, but
#  WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
#  General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import os

# from debug_tools.third_part import print_all_variables_for_debugging
# if 'g_channelSettings' in globals(): print_all_variables_for_debugging( g_channelSettings )
# import sublime_plugin; sublime_plugin.reload_plugin( "channel_manager.channel_manager" )
# import sublime_plugin; sublime_plugin.reload_plugin( "channel_manager.submodules_manager" )

from debug_tools.third_part import clean_urljoin
from channel_manager.channel_utilities import run_channel_setup

CURRENT_PACKAGE_FILE   = os.path.dirname( os.path.realpath( __file__ ) )
PACKAGE_ROOT_DIRECTORY = CURRENT_PACKAGE_FILE.replace( ".sublime-package", "" )
CURRENT_PACKAGE_NAME   = os.path.basename( PACKAGE_ROOT_DIRECTORY )

def plugin_loaded():
    global g_channelSettings
    CHANNEL_RAW_URL = "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/"

    g_channelSettings = {}
    g_channelSettings['CHANNEL_ROOT_URL']    = "https://github.com/evandrocoan/AmxxSimpleIDE"
    g_channelSettings['DEFAULT_CHANNEL_URL'] = "https://packagecontrol.io/channel_v3.json"

    g_channelSettings['CHANNEL_FILE_URL']  = clean_urljoin( CHANNEL_RAW_URL, "channel.json" )
    g_channelSettings['CHANNEL_FILE_PATH'] = os.path.join( PACKAGE_ROOT_DIRECTORY, "channel.json" )

    g_channelSettings['CHANNEL_REPOSITORY_URL']  = clean_urljoin( CHANNEL_RAW_URL, "repository.json" )
    g_channelSettings['CHANNEL_REPOSITORY_FILE'] = os.path.join( PACKAGE_ROOT_DIRECTORY, "repository.json" )

    g_channelSettings['PACKAGES_TO_INSTALL_FIRST'] = \
    [
        "Notepad++ Color Scheme",
    ]

    g_channelSettings['PACKAGES_TO_INSTALL_LAST'] = \
    [
        "Default",
        "PackagesManager",
    ]

    g_channelSettings['FORBIDDEN_PACKAGES'] = \
    [
        "PackagesManager",
        "Notepad++ Color Scheme",
        "Default",
        "RememberCommandPaletteInput",
        "ClearCursorsCarets",
        "AmxxPawn",
        "AmxxEditor",
    ]

    g_channelSettings['PACKAGES_TO_NOT_INSTALL_STABLE'] = \
    [
        "User",
    ]

    g_channelSettings['PACKAGES_TO_NOT_INSTALL_DEVELOPMENT'] = \
    [
    ]

    g_channelSettings['PACKAGES_TO_INSTALL_EXCLUSIVELY'] = \
    [
        "AltUp",
        "AmxxChannel",
        "AmxxEditor",
        "AmxxPawn",
        "BBCode",
        "BetterFindBuffer",
        "ClearCursorsCarets",
        "Default",
        "DefaultSyntax",
        "Diff",
        "FixedToggleFindPanel",
        "FixProjectSwitchRestartBug",
        "ForceRewriteSublimeSettings",
        "MoveText",
        "Notepad++ Color Scheme",
        "OverrideCommitCompletion",
        "OverrideUnpackedPackages",
        "PackagesManager",
        "PowerCursors",
        "RememberCommandPaletteInput",
        "SideBySideSettings",
    ]

    g_channelSettings['PACKAGES_TO_IGNORE_ON_DEVELOPMENT'] = \
    [
    ]

    g_channelSettings['CHANNEL_VERSIONS_DESCRIPTIONS'] = """\
        There are two versions of the channel. Each one of them has its proper usage depending on
        your plans. The Stable Version is the most tested and trusted set of packages to be
        installed. It contains all the packages which can be actively enabled and used on daily
        basis usage and it requires the latest Stable Build of Sublime Text available, as builds
        3126 and 3143.

        The Development Version has the same packages as the Stable Version, however it also
        installs candidate packages to the Stable Version, i.e., packages which are not thoroughly
        tested. Some of them are expected to have serious bugs as crash your Sublime Text,
        significantly slow down the Sublime Text performance, i.e., create great problems. Due this,
        these extra packages are by default added to your `ignored_packages` settings. You should
        only enable them when you are attempting to fix their problems or test them.

        For both Stable and Development versions, your Sublime Text's Package Control will be
        uninstalled and replaced by the its forked version called `PackagesManager`. Now on, you
        should look for the package `PackagesManager` to install and uninstalling packages. The
        Stable Version installs all packages by PackagesManager as they normally are installed by
        the Sublime Text's Package Control. Therefore they require smaller amount of space in your
        file system. It should be about 60MB of data, on the last time checked.

        Now the Development Version installs all your packages by `git`, therefore you need to have
        git installed in your system in order to install the development Version. Also due this, the
        Development Version requires much more file system space. The last time checked it required
        about 600MB of free space. Notice also, the Development Version requires the latest
        Development Build of Sublime Text available, as builds 3141 and 3147.
        """

    run_channel_setup( g_channelSettings, CURRENT_PACKAGE_FILE )