Merge pull request #458 from glennsarti/add-puppetfile-language

(GH-295)(GH-288) Add puppetfile support

Author: James Pogran

languages/puppetfile-language-configuration.json

@@ -0,0 +1,38 @@
+{
+  "comments": {
+    // symbol used for single line comment. Remove this entry if your language does not support line comments
+    "lineComment": "#",
+    // symbols used for start and end a block comment. Remove this entry if your language does not support block comments
+    "blockComment": ["/*","*/"]
+  },
+  // symbols used as brackets
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  // symbols that are auto closed when typing
+  "autoClosingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    ["\"", "\""],
+    ["'", "'"]
+  ],
+  // symbols that that can be used to surround a selection
+  "surroundingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    ["\"", "\""],
+    ["'", "'"]
+  ],
+  // support for region folding
+  "folding": {
+    "offSide": true,
+    "markers": {
+      "start": "^\\s*#\\s*region\\b",
+      "end": "^\\s*#\\s*endregion\\b"
+    }
+  }
+}

package.json

@@ -39,6 +39,7 @@
   ],
   "activationEvents": [
     "onLanguage:puppet",
+    "onLanguage:puppetfile",
     "onCommand:extension.puppetShowConnectionLogs",
     "onCommand:extension.puppetShowConnectionMenu",
     "onCommand:extension.puppetLint",
@@ -65,6 +66,17 @@
           ".epp"
         ],
         "configuration": "./languages/puppet-language-configuration.json"
+      },
+      {
+        "id": "puppetfile",
+        "aliases": [
+          "Puppetfile",
+          "PuppetFile"
+        ],
+        "filenames": [
+          "Puppetfile"
+        ],
+        "configuration": "./languages/puppetfile-language-configuration.json"
       }
     ],
     "jsonValidation": [
@@ -82,6 +94,11 @@
         "language": "puppet",
         "scopeName": "source.puppet",
         "path": "./syntaxes/puppet.tmLanguage"
+      },
+      {
+        "language": "puppetfile",
+        "scopeName": "source.ruby",
+        "path": "./syntaxes/puppetfile.cson.json"
       }
     ],
     "snippets": [
@@ -92,6 +109,10 @@
       {
         "language": "json",
         "path": "./snippets/metadata.snippets.json"
+      },
+      {
+        "language": "puppetfile",
+        "path": "./snippets/puppetfile.snippets.json"
       }
     ],
     "commands": [

snippets/puppetfile.snippets.json

@@ -0,0 +1,62 @@
+{
+  "Forge_module1": {
+    "prefix": "Forge Module",
+    "body": ["mod '${1:author}-${2:name}', '${3:version}'"],
+    "description": "Install from the forge"
+  },
+  "Forge_module2": {
+    "prefix": "Latest Forge Module",
+    "body": ["mod '${1:author}-${2:name}', :latest"],
+    "description": "Install the latest version from the forge"
+  },
+  "Git_module1": {
+    "prefix": "Git Module by ref",
+    "body": [
+      "mod '${1:name}',",
+      "\t:git => '${2:repository}',",
+      "\t:ref => '${3:reference}'"
+    ],
+    "description": "Install from a git repository specified by a git reference e.g. master"
+  },
+  "Git_module2": {
+    "prefix": "Git Module by commit",
+    "body": [
+      "mod '${1:name}',",
+      "\t:git    => '${2:repository}',",
+      "\t:commit => '${3:commit}'"
+    ],
+    "description": "Install from a git repository specified by a git commit e.g. 1c40e29"
+  },
+  "Git_module3": {
+    "prefix": "Git Module by tag",
+    "body": [
+      "mod '${1:name}',",
+      "\t:git => '${2:repository}',",
+      "\t:tag => '${3:tag}'"
+    ],
+    "description": "Install from a git repository specified by a git tag e.g. v1.0.0"
+  },
+  "Git_module4": {
+    "prefix": "Git Module by branch",
+    "body": [
+      "mod '${1:name}',",
+      "\t:git    => '${2:repository}',",
+      "\t:branch => '${3:branch}'"
+    ],
+    "description": "Install from a git repository specified by a git branch e.g. release"
+  },
+  "Svn_module1": {
+    "prefix": "Svn Module by revision",
+    "body": [
+      "mod '${1:name}',",
+      "\t:svn      => '${2:repository}',",
+      "\t:revision => '${3:revision}'"
+    ],
+    "description": "Install from a SVN repository specified by a revision e.g. 154"
+  },
+  "Local_module1": {
+    "prefix": "Local Module",
+    "body": ["mod '${1:name}', :local => true"],
+    "description": "Install from the local Puppetfile module path"
+  }
+}

src/PuppetStatusBar.ts

@@ -8,7 +8,7 @@ export class PuppetStatusBar {
   statusBarItem: vscode.StatusBarItem;
   private logger: ILogger;
 
-  constructor(langID: string, context:vscode.ExtensionContext, logger: ILogger) {
+  constructor(langIDs: string[], context:vscode.ExtensionContext, logger: ILogger) {
     this.logger = logger;
     context.subscriptions.push(vscode.commands.registerCommand(PuppetCommandStrings.PuppetShowConnectionMenuCommandId,
       () => { PuppetStatusBar.showConnectionMenu(); }
@@ -17,7 +17,7 @@ export class PuppetStatusBar {
     this.statusBarItem.command = PuppetCommandStrings.PuppetShowConnectionMenuCommandId;
     this.statusBarItem.show();
     vscode.window.onDidChangeActiveTextEditor(textEditor => {
-      if (textEditor === undefined || textEditor.document.languageId !== langID) {
+      if (textEditor === undefined || langIDs.indexOf(textEditor.document.languageId) === -1) {
         this.statusBarItem.hide();
       } else {
         this.statusBarItem.show();

src/extension.ts

@@ -21,7 +21,9 @@ import { PuppetStatusBar } from './PuppetStatusBar';
 import { ISettings, legacySettings, settingsFromWorkspace } from './settings';
 import { Reporter, reporter } from './telemetry/telemetry';
 
-const langID = 'puppet'; // don't change this
+export const puppetLangID = 'puppet'; // don't change this
+export const puppetFileLangID = 'puppetfile'; // don't change this
+
 let extContext: vscode.ExtensionContext;
 let connectionHandler: ConnectionHandler;
 let settings: ISettings;
@@ -40,7 +42,7 @@ export function activate(context: vscode.ExtensionContext) {
 
   settings       = settingsFromWorkspace();
   logger         = new OutputChannelLogger(settings);
-  statusBar      = new PuppetStatusBar(langID, context, logger);
+  statusBar      = new PuppetStatusBar([puppetLangID, puppetFileLangID], context, logger);
   configSettings = new ConnectionConfiguration();
 
   if(settings.editorService.enable === false){
@@ -68,8 +70,8 @@ export function activate(context: vscode.ExtensionContext) {
 
   extensionFeatures = [
     new DebugConfigurationFeature(logger, extContext),
-    new FormatDocumentFeature(langID, connectionHandler, settings, logger, extContext),
-    new NodeGraphFeature(langID, connectionHandler, logger, extContext),
+    new FormatDocumentFeature(puppetLangID, connectionHandler, settings, logger, extContext),
+    new NodeGraphFeature(puppetLangID, connectionHandler, logger, extContext),
     new PDKFeature(extContext, logger),
     new PuppetResourceFeature(extContext, connectionHandler, logger)
   ];

src/handler.ts

@@ -7,6 +7,7 @@ import { OutputChannelLogger } from './logging/outputchannel';
 import { ISettings } from './settings';
 import { PuppetVersionDetails, PuppetVersionRequest, PuppetCommandStrings } from './messages';
 import { reporter } from './telemetry/telemetry';
+import { puppetFileLangID, puppetLangID} from './extension';
 
 export abstract class ConnectionHandler {
   private timeSpent:number;
@@ -37,7 +38,7 @@ export abstract class ConnectionHandler {
     this.timeSpent = Date.now();
     this.setConnectionStatus('Initializing', ConnectionStatus.Initializing);
 
-    let documents = [{ scheme: 'file', language: 'puppet' }];
+    let documents = [{ scheme: 'file', language: puppetLangID }, { scheme: 'file', language: puppetFileLangID }];
 
     this.logger.debug('Configuring language client options');
     let clientOptions: LanguageClientOptions = {