tajmone / sublime-alan-if Goto Github PK

Tweak the Alan syntax definition to avoid any potential conflicts with the Alan programming language by Alan Technologies, Inc (alantech/alan#548).

File Names

In the event of an upcoming package for Alan Tech's Alan lang we should rename all the syntaxes files and their internal names to avoid conflicts in case a user installs both this package and theirs.

• ALAN — Alan.sublime-syntax
  • Rename Syntax to Alan IF.sublime-syntax
    • name: ALan IF
  • Rename all associated ST files and themes accordingly.
• ALAN Solution — Alan Solution.sublime-syntax
  • Rename Syntax to Alan IF Solution.sublime-syntax
    • name: ALan IF Solution
  • Rename all associated ST files and themes accordingly.
• ALAN Transcript — Alan Transcript.sublime-syntax
  • Rename Syntax to Alan IF Transcript.sublime-syntax
    • name: ALan IF Transcript
  • Rename all associated ST files and themes accordingly.

Scopes

Likewise, we should change the base scope name used by this package.

• ALAN → source.alanif
  • Fix all other package files that rely on scope for their functionality:
    • Build files.
    • Color schemes.
    • Comments Preferences.
    • Completions.
    • Indentation rules.
    • Snippets.
    • Symbols.
    • Syntax tests.

The scopes of the other syntaxes are fine, and not at risk of clashing:

• ALAN Solution → source.a3s
• ALAN Transcript → source.a3t

To avoid any potential conflicts with the Alan programming language by Alan Technologies, Inc (alantech/alan#548), change repository name of this package since Alan Tech is planning to create their own Sublime Text package (alantech/alan#257).

• Rename repository to sublime-alan-if

Switch to the upcoming official extensions .a3s and .a3t for ALAN3 solution files and transcripts, respectively (see alan-if/alan#2):

• Update syntaxes:
  • Alan Transcript.sublime-syntax:
    • Add .a3t as main extension (but keep .a3log).
    • Change scope from .a3log to .a3t.
    • Update scopes and references in all package files.
  • Alan Solution.sublime-syntax:
    • Add .a3s as main extension (but keep .a3sol).
    • Change scope from .a3sol to .a3s.
    • Update scopes and references in all package files.
• Rename snippets-a3sol/ folder.
• Update documentation accordingly.

NOTE — Initially I'll add the new extensions along with the old ones (.a3sol and .a3log) for a grace period, so that old projects would still be usable in Sublime ALAN.

Enforce code styles consistency to the repository:

• Add and enforce EditorConfig rules.
• Add code styles validation script (via EClint).
• Enable Travis CI code styles validation (via EClint).
  • Add Travis badge (and others) to README.
• Git hooks for local commit validation (via EClint).