Ctrl+F5, autosave before run, fix readme

doublefint · doublefint · commit e12e1c7965c5 · 2017-02-10T21:37:27.000+03:00
diff --git a/client/README.md b/client/README.md
@@ -1,27 +1,37 @@
 # pgsql extension
 
-This extension is fixed [clone](https://github.com/jptarqu/VSCodeExtension-PostgreSQL) of [postgresql by JPTarquino](https://marketplace.visualstudio.com/items?itemName=JPTarquino.postgresql)
+This extension is fixed clone of [postgresql](https://marketplace.visualstudio.com/items?itemName=JPTarquino.postgresql) by [JPTarquino](https://github.com/jptarqu/VSCodeExtension-PostgreSQL)
 
 ## Features:
-- Run current file into Postgres via psql
-- Colorization
-- Completion Lists for global postgres functions (copied from the Postgres official documentation)
-- Snippets
+- Execute sql file into Postgres (*Ctrl+F5*) via [psql](https://www.postgresql.org/docs/current/static/app-psql.html)
+- Colorization - _converted from [mulander](https://github.com/mulander/postgres.tmbundle)_
+- Completion lists for keywords - _copied from the Postgres [documentation](https://www.postgresql.org/docs/current/static/sql-keywords-appendix.html#KEYWORDS-TABLE)_
+- Few snippets ( *Ctrl+Space, type 'pg'* )
 
-<img src="https://raw.githubusercontent.com/doublefint/vscode-pgsql/master/client/images/example.gif" alt="demo" style="width:480px;"/>
-
-## Fixes
-- use connection string with port and password
-- add stderr output ( thanks for [khushboo shah](https://marketplace.visualstudio.com/items?itemName=JPTarquino.postgresql) )
-- shorter command 
+The extension recognizes the \*.sql, \*.ddl, \*.dml, \*.pgsql extension as sql files intended to be run in Postgres
 
-The extension recognizes the .sql,.ddl,.dml,.pgsql extension as sql files intended to be run in Postgres.
+<img src="https://raw.githubusercontent.com/doublefint/vscode-pgsql/master/client/images/example.gif" alt="demo" style="width:480px;"/>
 
-## Using
-To run the current sql file through psql (Postgres native client) you must add the following settings to your workspace:
+## Usage
 
+- Setup **psql** is in the OS executable path
+- Customize Postgress connection ( settings in workspace ):
 ```javascript
 { "pgsql.connection": "postgres://username:password@host:port/database" }
 ```
-You must also ensure that psql is in the OS executable path (it will be executed as simply "psql" from vscode).
-The command to run the current file is "pgsql: run in postgres"
+
+- Open file with pgsql type, press **Ctrl+F5** ( Cmd+F5 on Mac )
+- For snippets press **Ctrl+Space**, type '**pg**' 
+
+
+## Release Notes
+
+### 0.0.7
+- run pgsql files - press Ctrl+F5 
+- autosave changed pgsql file before run
+- change [Create Function](http://rob.conery.io/2015/02/21/its-time-to-get-over-that-stored-procedure-aversion-you-have/) snippet 
+
+### 0.0.2
+- add connection config with port and password
+- add stderr output ( thanks for [khushboo shah](https://marketplace.visualstudio.com/items?itemName=JPTarquino.postgresql) )
+- rename to pgsql  
diff --git a/client/package.json b/client/package.json
@@ -2,7 +2,7 @@
   "name": "pgsql",
   "description": "postgres language support, snippets, runner. Fixed clone of postgresql@0.0.2 by JPTarquino",
   "license": "MIT",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "publisher": "doublefint",
   "engines": { "vscode": "^0.10.1" },
   "icon": "images/logo.png",
@@ -12,17 +12,20 @@
   "main": "./out/extension",
   "contributes": {
 
-    "commands": [
-      { "category": "pgsql", "command": "pgsql.run", "title": "run sql in postgres" }
-    ],
+    "commands": [{ "category": "pgsql", "command": "pgsql.run", "title": "run in postgres" }],
+    
+    "keybindings": [{
+        "command": "pgsql.run",
+        "key": "ctrl+f5", "mac": "cmd+f5",
+        "when": "editorTextFocus && editorLangId == pgsql"
+    }],
 
     "languages": [{
         "id": "pgsql",
         "extensions": [ ".sql", ".ddl", ".dml", ".pgsql" ],
-        "aliases": [ "pgsql", "postgres", "postgreSQL", "plpgsql", "pg" ],
+        "aliases": [ "pgsql", "postgres", "PostgreSQL" ],
         "configuration": "./pgsql.configuration.json"
-      }
-    ],
+    }],
     
     "snippets": [ { "language": "pgsql", "path": "./snippets/pgsql_snippets.json" } ],
     
diff --git a/client/pgsql.configuration.json b/client/pgsql.configuration.json
@@ -9,12 +9,5 @@
 		["[", "]"],
 		["(", ")"]
 	]
-	/*
-	enhancedBrackets:[
-		{ openTrigger: 'n', open: /begin$/i, closeComplete: 'end', matchCase: true },
-		{ openTrigger: 'e', open: /case$/i, closeComplete: 'end', matchCase: true },
-		{ openTrigger: 'n', open: /when$/i, closeComplete: 'then', matchCase: true }
-	],
-	noindentBrackets: '()',
-	*/
+
 }
diff --git a/client/snippets/pgsql_snippets.json b/client/snippets/pgsql_snippets.json
@@ -1,47 +1,43 @@
 {
-    
-	"Select simple": {
-		"prefix": "sel",
+	"Select Statement": {
+		"prefix": "pgsql",
 		"body": [
-			"SELECT ${tableName}.",
-			"FROM ${tableName}",
-			"WHERE"
+			"Select * ",
+			  "From ${tableName}",
+			 "Where 1=1 And id = ? ",
+			 ";"
 		],
-		"description": "Simple Select with Where"
+		"description": "Insert 'Select * From ... Where ... ' statement"
 	},
-    
-	"PL/PGSQL Function": {
-		"prefix": "funcplpg",
+   
+	"Create Function": {
+		"prefix": "pgsql",
 		"body": [
-			"CREATE OR REPLACE FUNCTION ${funcName}(i integer) RETURNS integer AS $$",
-            "BEGIN",
-            "\tRETURN i + 1;",
-            "END;",
-            "$$ LANGUAGE plpgsql;"
+			"Create Or Replace Function ${funcName}( data json ) Returns json As $$",
+			"\tDeclare",
+			"\t\t-- declare variables",
+			"\t\t-- for example: id int := Cast( data->>'id' as int ); ",
+            "Begin",
+			"\t\t --do something useful",
+            "\tReturn '{}';",
+            "End;",
+            "$$ language plpgsql;"
 		],
-		"description": "Simple PL/PGSQL Function"
-	},
-    
-	"SQL Function": {
-		"prefix": "funcplpg",
-		"body": [
-			"CREATE OR REPLACE FUNCTION ${funcName}(i integer) RETURNS integer AS $$",
-            "\tSELECT $1, CAST($1 AS text) || ' is text' ",
-            "$$ LANGUAGE SQL;"
-		],
-		"description": "Simple PL/PGSQL Function"
+		"description": "Insert 'Create Or Replace Function ...' statement"
 	},
     
 	"Create Table": {
-		"prefix": "tablepgsql",
+		"prefix": "pgsql",
 		"body": [
-			"CREATE TABLE ${tableName} (",
-            "\tid serial,",
-            "\tname text,",
-            "\tquantity integer,",
-            "\tCONSTRAINT pk_${tableName} PRIMARY KEY(id)",
-            ");"
-		],
-		"description": "Create Postgres Table"
+			"Create Table ${tableName} (",
+            "\tid serial primary key,",
+			"\tcd text not null,",
+            "\tnm text,",
+			"\t--ref int references another.table,",
+            "\tcreated timestamptz default now()",
+            ");",
+			"Create Index on ${tableName} (cd);"
+		], 
+		"description": "Insert 'Create Table ...' statement"
 	}
 }
diff --git a/client/src/features/commandProvider.ts b/client/src/features/commandProvider.ts
@@ -1,79 +1,108 @@
 
-import * as vscode from 'vscode';
-import * as ChPr from 'child_process';
+import { window, workspace, ViewColumn, OutputChannel, Disposable } from 'vscode';
+import * as ChildProcess from 'child_process';
 import LineDecoder from './lineDecoder';
 
 
 export default class pgsqlCommandProvider  {
     
     private executable :string = 'psql'
     private connection :string
-    private outChannel : vscode.OutputChannel;
+    private outChannel : OutputChannel;
     
-    public activate(subscriptions: vscode.Disposable[]) {
+    public activate(subscriptions: Disposable[]) {
         let cp = this
-        cp.outChannel = vscode.window.createOutputChannel("pgsql")
-        vscode.workspace.onDidChangeConfiguration( cp.loadConfiguration, cp, subscriptions )
+        cp.outChannel = window.createOutputChannel("pgsql")
+        workspace.onDidChangeConfiguration( cp.loadConfiguration, cp, subscriptions )
 		cp.loadConfiguration()
 	}
     
     public loadConfiguration():void  {
-        let section = vscode.workspace.getConfiguration('pgsql')
+        let section = workspace.getConfiguration('pgsql')
 		if (section) {
 			this.connection = section.get<string>('connection', null)
 		}
     }
 
     public run():void {
 
-        let cpv = this // [c]ommand [p]ro[v]ider
+        if ( !window.activeTextEditor ) return // No open text editor
+
+        let doc = window.activeTextEditor.document
+
+        // if doc never saved before
+        // vscode change editor after save
+        if ( doc.isUntitled ) { 
+           
+           window.showInformationMessage( 'pgsql: Please, save document and press Ctrl+F5 again' )
+           return  
+        } 
+
+        let pgsql = this 
         
-        let editor = vscode.window.activeTextEditor
+        // file already have real filename, just run it via psql
+        if ( !doc.isDirty ) return pgsql.runFile( doc.fileName )
         
-        if ( !editor ) return // No open text editor
+        // file was changed (dirty), save it andthen
+        doc.save().then( ( saved: boolean ) => {
+            if ( !saved ) return
+            pgsql.runFile( doc.fileName )
+        }, e => {
+            console.log( 'pgsql: doc.save() rejected' )
+        })
         
-        let args = [  
-            "-d", cpv.connection,
-            "-f", editor.document.fileName
-        ]
+    }
+
+    public runFile( fileName: string ): void {
+
+        let pgsql = this,
+            args = [  
+                "-d", pgsql.connection,
+                "-f", fileName
+            ]
         
-        let childProcess = ChPr.spawn( cpv.executable, args )
-        args.unshift( cpv.executable )
-        console.log( args.join(" ") )
+        let cp = ChildProcess.spawn( pgsql.executable, args )
+
+        //args.unshift( pgsql.executable )
+        //console.log( args.join(" ") )
         
-        childProcess.on('error', ( err: Error ) => {
+        cp.on( 'error', ( err: Error ) => {
             
             let ecode: string = (<any>err).code 
-            let message: string = err.message || `Failed to run: ${cpv.executable} ${args.join(' ')}. ${ecode}.`
+            let defmsg = `Failed to run: ${pgsql.executable} ${args.join(' ')}. ${ecode}.`
+            let message: string = err.message || defmsg
             
             if ((<any>err).code === 'ENOENT') {
                 message = `The 'psql' program was not found. Please ensure the 'psql' is in your Path`
             } 
-            vscode.window.showInformationMessage( message )
+            window.showInformationMessage( message )
             
         });
 
-        if (childProcess.pid) {
-            
-            let decoder = new LineDecoder()
-            cpv.outChannel.show( vscode.ViewColumn.Two )
-            
-            childProcess.stdout.on('data', (data) => {
-                decoder.write(data).forEach( function (line:string) {
-                    cpv.outChannel.appendLine( line )
-                })
+        pgsql.outChannel.show( ViewColumn.Two )
+        
+        if ( !cp.pid ){
+            return pgsql.outChannel.appendLine( 'pgsql: can\'t spawn child proceess' )    
+        }
+          
+        let decoder = new LineDecoder()
+        pgsql.outChannel.show( ViewColumn.Two )
+        
+        cp.stdout.on('data', (data) => {
+            decoder.write(data).forEach( function (line:string) {
+                pgsql.outChannel.appendLine( line )
             })
-            
-            childProcess.stderr.on('data', ( data ) => {
-                decoder.write( data ).forEach( function (line:string) {
-                    cpv.outChannel.appendLine( line )
-                })
+        })
+        
+        cp.stderr.on('data', ( data ) => {
+            decoder.write( data ).forEach( function (line:string) {
+                pgsql.outChannel.appendLine( line )
             })
+        })
 
-            childProcess.stdout.on('end', () => {
-                cpv.outChannel.appendLine('pgsql executed.')
-            })
+        cp.stdout.on('end', () => {
+            pgsql.outChannel.appendLine('pgsql end.')
+        })
 
-        } 
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,5 @@`
`9`	`9`	`["[", "]"],`
`10`	`10`	`["(", ")"]`
`11`	`11`	`]`
`12`		`- /*`
`13`		`- enhancedBrackets:[`
`14`		`- { openTrigger: 'n', open: /begin$/i, closeComplete: 'end', matchCase: true },`
`15`		`- { openTrigger: 'e', open: /case$/i, closeComplete: 'end', matchCase: true },`
`16`		`- { openTrigger: 'n', open: /when$/i, closeComplete: 'then', matchCase: true }`
`17`		`- ],`
`18`		`- noindentBrackets: '()',`
`19`		`- */`
	`12`	`+`
`20`	`13`	`}`