042

Author: ctf0

CHANGELOG.md

@@ -74,3 +74,7 @@ All notable changes to the "php-namespace-resolver" extension will be documented
 - if use statement already exists, no changes will be made
 - support importing/expanding class FQN when its called with a partial FQN ex.`Rules\Password` + `use Illuminate\Validation\Rules;`
 - you will get an error msg if a use statement already exists with a similar class name of what u r trying to import ex.`use Illuminate\Facade\Password;` + importing ex.`Rules\Password`
+
+## 0.4.2
+
+- fix not parsing of other types than class

README.md

@@ -35,3 +35,4 @@ NS_EXTENSION_PROVIDER.insertNamespace() // insert namespace in current active fi
 - make sure to run `composer dump` first & fix any reported issues.
 - run `PHP Namespace Resolver: Check for namespaces project wide`
     - note that commented out FQN will show up in the problems panel as well, the cmnd lists all the namespaces that are unknown regardless of its position
+    - also you might get positive-negative results because of nested namespaces, which will need more work to check if the namespace correspond to an actual file path or not

package.json

@@ -2,7 +2,7 @@
     "name": "php-namespace-resolver",
     "displayName": "PHP Namespace Resolver",
     "description": "Import and expand php namespaces",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "publisher": "ctf0",
     "author": "ctf0",
     "repository": "https://github.com/ctf0/PHP-Namespace-Resolver",
@@ -21,11 +21,6 @@
     ],
     "activationEvents": [
         "workspaceContains:composer.json",
-        "namespaceResolver.import",
-        "namespaceResolver.importAll",
-        "namespaceResolver.expand",
-        "namespaceResolver.sort",
-        "namespaceResolver.generateNamespace",
         "onStartupFinished"
     ],
     "main": "./out/main",
@@ -225,7 +220,20 @@
                     },
                     "minItems": 1,
                     "uniqueItems": true,
-                    "markdownDescription": "exclude directories from namespace use call search\n\n(.gitignore contents are already excluded)"
+                    "markdownDescription": "exclude directories from namespace import search\n\n(.gitignore contents are already excluded)"
+                },
+                "namespaceResolver.checkForNamespaces.rg.excludeFiles": {
+                    "type": "array",
+                    "default": [
+                        "_ide_helper.php",
+                        ".phpstorm.meta.php"
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "minItems": 1,
+                    "uniqueItems": true,
+                    "markdownDescription": "exclude files from namespace import search\n\n(.gitignore contents are already excluded)"
                 }
             }
         }
@@ -238,19 +246,19 @@
         "watch": "npm run esbuild"
     },
     "devDependencies": {
-        "@types/fs-extra": "^9.0.13",
-        "@types/node": "^18.11.4",
+        "@types/fs-extra": "^11.0.1",
+        "@types/node": "^18.11.18",
         "@types/vscode": "^1.68.0",
-        "esbuild": "^0.15.13",
-        "typescript": "^4.6.3"
+        "esbuild": "^0.17.3",
+        "typescript": "^4.9.4"
     },
     "dependencies": {
         "escape-string-regexp": "^5.0.0",
         "execa": "^6.1.0",
         "find-up": "^6.3.0",
         "fs-extra": "^11.1.0",
         "lodash.groupby": "^4.6.0",
-        "node-natural-sort": "^0.8.6",
-        "php-parser": "^3.1.2"
+        "natural-orderby": "^3.0.2",
+        "php-parser": "^3.1.3"
     }
 }

src/NamespaceCheck.ts

@@ -8,11 +8,10 @@
  * add the unknown statements to the diagnose panel
  */
 
-import escapeStringRegexp from 'escape-string-regexp';
 import { execa } from 'execa';
+import groupBy from 'lodash.groupby';
 import * as vscode from 'vscode';
 import Resolver from './Resolver';
-const _groupBy = require('lodash.groupby');
 
 export default async function checkForNamespaces(resolver: Resolver, createDiagnosticCollection: vscode.DiagnosticCollection) {
     if (resolver.CWD) {
@@ -85,24 +84,32 @@ async function getAutoloadFileData(resolver: Resolver): Promise<any> {
 
 async function searchAllFilesForImports(resolver: Resolver): Promise<any> {
     const rgCommand = resolver.config('checkForNamespaces.rg.command');
-    const rgExcludeDirs = resolver.config('checkForNamespaces.rg.excludeDirs').map((item) => escapeStringRegexp(item)).join(',');
-
-    if (!rgCommand || !rgExcludeDirs) {
-        throw new Error('config required : rgCommand,rgExcludeDirs');
+    const rgExcludeDirs = resolver
+        .config('checkForNamespaces.rg.excludeDirs')
+        .join(',');
+    const rgExcludeFiles = resolver
+        .config('checkForNamespaces.rg.excludeFiles')
+        .join(',');
+
+    if (!rgCommand || !rgExcludeDirs || !rgExcludeFiles) {
+        throw new Error('config required : rgCommand,excludeDirs,excludeFiles');
     }
 
-    const { stdout } = await execa(rgCommand, [
-        "'((namespace|use) )?\\\\?(\\w+\\\\)+\\w+(?=[ ;:\\(])'",
+    const args = [
+        '\'((namespace|use) )?\\\\?(\\w+\\\\)+\\w+(?=[ ;:\\(])\'',
         '--mmap',
         '--pcre2',
         '--no-messages',
         '--line-number',
         '--only-matching',
-        "--glob='!*blade.php'",
+        '--glob=\'**/*.php\'',
+        '--glob=\'!*.blade.php\'',
         `--glob='!{${rgExcludeDirs}}'`,
-        "--glob='**/*.php'",
-        "./",
-    ], {
+        `--glob='!{${rgExcludeFiles}}'`,
+        './',
+    ];
+
+    const { stdout } = await execa(rgCommand, args, {
         cwd   : resolver.CWD,
         shell : vscode.env.shell,
     });
@@ -164,7 +171,7 @@ async function searchAllFilesForImports(resolver: Resolver): Promise<any> {
 }
 
 function findNonFoundNamespaces(appNamespaces, importsFiles) {
-    importsFiles = _groupBy(importsFiles, 'import');
+    importsFiles = groupBy(importsFiles, 'import');
     const list: any = [];
 
     for (const namespace of Object.keys(importsFiles)) {

src/Parser.ts

@@ -16,12 +16,12 @@ export function buildClassASTFromContent(content: string) {
     try {
         const AST = Parser.parseCode(content, '*.php');
 
-        const _tag: any = AST.tokens?.find((item: any) => item[0] == "T_OPEN_TAG");
-        const _declare: any = AST.children?.find((item: any) => item.kind == "declare");
+        const _tag: any = AST.tokens?.find((item: any) => item[0] == 'T_OPEN_TAG');
+        const _declare: any = AST.children?.find((item: any) => item.kind == 'declare');
         const _namespace: any = AST.children?.find((item: any) => item.kind == 'namespace');
         const _use: any = (_namespace || AST).children?.filter((item: any) => item.kind == 'usegroup');
-        const _class: any = (_namespace || AST).children?.find((item: any) => item.kind == 'class');
-        const _trait: any = _class?.body?.find((item: any) => item.kind == "traituse")?.traits;
+        const _class: any = (_namespace || AST).children?.find((item: any) => ['class', 'enum', 'interface', 'trait'].includes(item.kind));
+        const _trait: any = _class?.body?.find((item: any) => item.kind == 'traituse')?.traits;
 
         return {
             _openTag: {

src/Resolver.ts

@@ -1,7 +1,7 @@
 import { execaCommand } from 'execa';
 import { findUp } from 'find-up';
 import fs from 'fs-extra';
-import naturalSort from 'node-natural-sort';
+import { compare } from 'natural-orderby';
 import path from 'node:path';
 import * as vscode from 'vscode';
 import BUILT_IN_CLASSES_FB from './classes';
@@ -77,7 +77,7 @@ export default class Resolver {
         if (_class?.implements !== null) {
             phpClasses = phpClasses.concat(
                 _class.implements
-                    .filter((item) => item.resolution == "uqn")
+                    .filter((item) => item.resolution == 'uqn')
                     .map((item) => item.name),
             );
         }
@@ -95,7 +95,7 @@ export default class Resolver {
         const methods = _class.body?.filter((item) => item.kind === 'method' && item.arguments.length);
 
         return methods?.map((item) => item.arguments
-            .filter((arg) => arg.type.kind == 'name' && arg.type.resolution == "uqn")
+            .filter((arg) => arg.type.kind == 'name' && arg.type.resolution == 'uqn')
             .map((arg) => arg.type.name));
     }
 
@@ -426,9 +426,8 @@ export default class Resolver {
         };
 
         if (this.config('sort.natural')) {
-            const natsort = naturalSort({
-                caseSensitive : true,
-                order         : alpha ? 'ASC' : 'DESC',
+            const natsort = compare({
+                order: alpha ? 'asc' : 'desc',
             });
 
             sortFunction = (a, b) => natsort(a.text, b.text);
@@ -537,7 +536,7 @@ export default class Resolver {
     }
 
     resolving(selection) {
-        if (typeof selection === "string") {
+        if (typeof selection === 'string') {
             return selection;
         }
 
@@ -571,7 +570,7 @@ export default class Resolver {
     /**
      * @param uri: ?vscode.Uri
      */
-    async generateNamespace(returnDontInsert = false, uri = null) {
+    async generateNamespace(returnDontInsert = false, uri?: vscode.Uri) {
         if (!returnDontInsert) {
             this.setEditorAndAST();
         }

src/extension.ts

@@ -27,7 +27,7 @@ export async function activate(context) {
     );
 
     return {
-        getNamespace(uri = null) {
+        getNamespace(uri?: vscode.Uri) {
             return resolver.generateNamespace(true, uri);
         },
         insertNamespace() {