Add user setting and prepare release

Author: njqdev

CHANGELOG.md

@@ -1,7 +1,5 @@
 # Change Log
 
-All notable changes to the "vscode-python-autohint" extension will be documented in this file.
+## [1.0.0]
 
-## [0.5.0]
-
-- Initial release
+* Initial release

README.md

@@ -1,4 +1,4 @@
-# vscode-python-autohint README
+# Python Type Hint
 
 Provides type hint auto-completion for Python.
 
@@ -10,12 +10,16 @@ Provides type hint auto-completion for Python.
 
 * Searches Python files in the workspace for type estimation purposes.
 
+* Can provide completion items for the typing module if it is imported.
+
 ## Installation
 
 Get this extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=).
 
 ## Known Issues
 
-* The difference between classes and function calls when detecting types is determined by the first letter being upper case (unless the class or function is defined in the currently edited document).
+* The difference between function and class constructor calls when detecting types is determined by the first letter being upper case (unless the class or function is defined in the currently edited document).
+
+* Up to 20 files within in the workspace are searched at a time. The limit is by design to keep the extension light weight, but there's probably a better solution.
 
 -------------------------------------------------------------------------------------------

images/icon.png

@@ -39,11 +39,21 @@
 					".py"
 				]
 			}
-		]
+        ],
+        "configuration": {
+            "title": "Python Type Hint",
+            "properties": {
+              "pyTypehint.search.limit": {
+                "type": "number",
+                "default": 30,
+                "description": "When providing type hint items, the number of files searched will be limited by this setting."
+              }
+            }
+        }
 	},
 	"scripts": {
-		"package": "npx vsce package",
-        "publish": "npx vsce publish",
+		"package": "vsce package",
+        "publish": "vsce publish",
 
         "vscode:prepublish": "webpack --mode production",
         "compile": "webpack --mode none",

package.json

@@ -12,6 +12,7 @@ import {
 import { TypeHintProvider } from "./typeHintProvider";
 import { paramHintTrigger, returnHintTrigger, PythonType } from "./python";
 import { TypeHint, labelFor } from "./typeHint";
+import { TypeHintSettings } from "./settings";
 
 
 abstract class CompletionProvider {
@@ -32,6 +33,13 @@ abstract class CompletionProvider {
  */
 export class ParamHintCompletionProvider extends CompletionProvider implements CompletionItemProvider {
 
+    private settings: TypeHintSettings;
+
+    constructor(settings: TypeHintSettings) {
+        super();
+        this.settings = settings;
+    }
+
     public async provideCompletionItems(
         doc: TextDocument, 
         pos: Position,
@@ -44,7 +52,7 @@ export class ParamHintCompletionProvider extends CompletionProvider implements C
 
             if (this.shouldProvideItems(line, pos)) {
                 const param = this.findParam(line, pos);
-                const provider = new TypeHintProvider(doc);
+                const provider = new TypeHintProvider(doc, this.settings);
 
                 if (param && param.length > 0) {
                     try {

src/completionProvider.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import { ParamHintCompletionProvider, ReturnHintCompletionProvider } from './completionProvider';
 import { paramHintTrigger, returnHintTrigger } from "./python";
+import { TypeHintSettings } from './settings';
 
 // Called when the extension is activated.
 export function activate(context: vscode.ExtensionContext) {
@@ -9,10 +10,20 @@ export function activate(context: vscode.ExtensionContext) {
 	function registerCommand(commandId: string, func: (...args: any[]) => void): void {
 		context.subscriptions.push(vscode.commands.registerCommand(commandId, func));
     }
-    
+
+    const settings = new TypeHintSettings();
+
     context.subscriptions.push(
-        vscode.languages.registerCompletionItemProvider('python', new ParamHintCompletionProvider(), paramHintTrigger),
-        vscode.languages.registerCompletionItemProvider('python', new ReturnHintCompletionProvider(), returnHintTrigger)
+        vscode.languages.registerCompletionItemProvider(
+            'python',
+            new ParamHintCompletionProvider(settings),
+            paramHintTrigger
+        ),
+        vscode.languages.registerCompletionItemProvider(
+            'python',
+            new ReturnHintCompletionProvider(),
+            returnHintTrigger
+        )
     );
 }
 

src/extension.ts

@@ -0,0 +1,33 @@
+import { workspace, Event, EventEmitter, window } from "vscode";
+
+export class TypeHintSettings {
+
+    private searchLimit = 50;
+
+    public get fileSearchLimit() {
+        return this.searchLimit;
+    }
+
+    constructor() {
+        workspace.onDidChangeConfiguration(() => {
+            this.initialize();
+            this.settingsUpdated.fire();
+        });
+        this.initialize();
+    }
+    
+    
+    public readonly settingsUpdated = new EventEmitter<void>();
+
+    public get onDidChangeConfiguration(): Event<void> {
+        return this.settingsUpdated.event;
+    }
+
+    private initialize() {
+        const searchLimit: number | undefined = workspace.getConfiguration('pyTypehint.search').get('limit');
+        if (searchLimit) {
+            this.searchLimit = searchLimit;
+        }
+    }
+
+}

src/settings.ts

@@ -4,6 +4,7 @@ import { TypeSearch } from "./typeSearch";
 import { TypingHintProvider } from "./typingHintProvider";
 import { WorkspaceSearcher } from "./workspaceSearcher";
 import { TypeHint, labelFor } from "./typeHint";
+import { TypeHintSettings } from "./settings";
 
 /**
  * Provides type hints.
@@ -22,14 +23,16 @@ export class TypeHintProvider {
     private typeContainer: DataTypeContainer = getDataTypeContainer();
     private typesIncludedInResult: { [key: string]: string } = {};
     private doc: TextDocument;
+    private settings: TypeHintSettings;
 
     /**
      * Constructs a new TypeHintProvider.
      * 
      * @param doc The active document.
      */
-    constructor(doc: TextDocument) {
+    constructor(doc: TextDocument, settings: TypeHintSettings) {
         this.doc = doc;
+        this.settings = settings;
     }
 
     /**
@@ -47,7 +50,7 @@ export class TypeHintProvider {
 
         const variableSearch = TypeSearch.variableWithSameName(param, documentText);
 
-        const wsSearcher = new WorkspaceSearcher(this.doc.uri);
+        const wsSearcher = new WorkspaceSearcher(this.doc.uri, this.settings);
         const wsSearch = wsSearcher.findHintOfSimilarParam(param, documentText);
 
         this.addIfNotNull(TypeSearch.classWithSameName(param, documentText), typeHints);

src/typeHintProvider.ts

@@ -1,4 +1,5 @@
 import { Uri, workspace } from "vscode";
+import { TypeHintSettings } from "./settings";
 import { TypeSearch } from "./typeSearch";
 
 /**
@@ -8,16 +9,16 @@ export class WorkspaceSearcher {
 
     private search: boolean = true;
     private activeDocUri: Uri;
-
-    private fileSearchLimit = 20;   // TODO: config
+    private settings: TypeHintSettings;
 
     /**
      * Constructs a new WorkspaceSearcher.
      * 
      * @param activeDocumentUri The uri of the active document.
      */
-    constructor(activeDocumentUri: Uri) {
+    constructor(activeDocumentUri: Uri, settings: TypeHintSettings) {
         this.activeDocUri = activeDocumentUri;
+        this.settings = settings;
     }
 
     /**
@@ -31,7 +32,7 @@ export class WorkspaceSearcher {
         this.search = true;
 
         if (workspace.workspaceFolders) {
-            const uris = (await workspace.findFiles("**/*.py", null, this.fileSearchLimit))
+            const uris = (await workspace.findFiles("**/*.py", null, this.settings.fileSearchLimit))
                 .filter(u => u.path !== this.activeDocUri.path);
 
             for (let i = 0; this.search && i < uris.length; i++) {