@nexus-ioc/language-service 0.1.0 → 0.2.0

package/README.md

@@ -2,14 +2,17 @@
 ![license](https://img.shields.io/npm/l/@nexus-ioc/cpre)
 ![build](https://img.shields.io/github/actions/workflow/status/Isqanderm/ioc/build.yml)
 
-Nexus IoC is a powerful and flexible Inversion of Control (IoC) container for TypeScript applications. Inspired by Angular and NestJS, it leverages decorators to provide a simple and efficient way to manage dependencies and modules.
+[Nexus IoC](https://www.npmjs.com/package/@nexus-ioc/core) is a powerful and flexible Inversion of Control (IoC) container for TypeScript applications. Inspired by Angular and NestJS, it leverages decorators to provide a simple and efficient way to manage dependencies and modules.
+
+
 
 ## Table of Contents
 
 - [Features](#features)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
-- [Testing](#testing)
+- [Example Project](#example-project)
+- [Roadmap](#roadmap)
 - [License](#license)
 - [Author](#author)
 - [Contributing](#contributing)
@@ -18,100 +21,72 @@ Nexus IoC is a powerful and flexible Inversion of Control (IoC) container for Ty
 
 ## Features
 
-- **Modular Architecture**: Easily create and manage modules.
-- **Dependency Injection**: Use decorators to inject dependencies into your classes.
-- **Lifecycle Management**: Manage the lifecycle of your components seamlessly.
-- **Asynchronous Module Loading**: Load modules asynchronously for improved performance.
+This plugin adds the ability to autocomplete for dependencies and highlight type errors.
 
 ## Installation
 
 ```bash
-npm install @nexus-ioc/core reflect-metadata
+npm install @nexus-ioc/language-service
 ```
 
 ## Quick Start
 
-### Step 1: Define Your Modules and Providers
-
-Create a module and a provider using decorators.
-
-```typescript
-import { NsModule, Injectable, Inject } from '@nexus-ioc/core';
-
-@Injectable()
-class DependencyService {
-  public readonly name = 'World';
-}
-
-@Injectable()
-export class AppService {
-  constructor(
-    @Inject(DependencyService)
-    private readonly dependencyService: DependencyService,
-  ) {
-  }
+### Step 1: Define plugin in tsconfig.json
 
-  getHello(): string {
-    return `Hello ${this.dependencyService.name}!`;
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@nexus-ioc/language-service"
+      }
+    ]
   }
 }
 
-@NsModule({
-  providers: [AppService, DependencyService],
-})
-export class AppModule {}
 ```
 
-### Step 2: Create an Application
+### Child containers
 
-Create and bootstrap your application.
+Modules declared in `@Module({ children })` are analysed as child scopes. A missing-dependency error in a child scope is suppressed when the declaring module can see the token in the parent graph. A module that is also imported outside a child scope keeps the diagnostic. Tokens the declaring module sees only through a re-export are not recognised yet. Tokens supplied per child instance (the `providers` of `forProfile()` or another dynamic module, or `createChild(..., { providers })`) are not visible to static analysis, so they may be reported as missing. See [Child containers](../ioc/README.md#child-containers).
 
-```typescript
-import { NexusApplicationsBrowser } from '@nexus-ioc/core/dist/server';
-import { AppModule, AppService } from './app.module';
+## Example Project
 
-async function bootstrap() {
-  const app = await NexusApplicationsBrowser
-    .create(AppModule)
-    .bootstrap();
-  
-  const appService = app.get<AppService>(AppService);
-  
-  console.log(appService?.getHello());
-}
-
-bootstrap();
-
-```
+A comprehensive example project is available in the `example/` directory that demonstrates all plugin features:
 
-## Testing
-
-### Installation
+- ✅ Auto-completion for `@Inject()` decorators
+- ✅ Go-to-definition for dependency tokens
+- ✅ Semantic diagnostics for DI errors
+- ✅ Working examples with proper module configuration
+- ✅ Error examples showing common mistakes
 
+**Quick Start**:
 ```bash
-npm install @nexus-ioc/testing
-```
+# From monorepo root
+cd packages/language-service/example
+npm install
+npm run build
 
-### Usage 
+# Open in your IDE
+code .
+```
 
-```typescript
-import { Injectable } from '@nexus-ioc/core';
-import { Test } from '@nexus-ioc/testing';
+See [`example/README.md`](./example/README.md) for detailed setup instructions and [`example/TESTING_GUIDE.md`](./example/TESTING_GUIDE.md) for comprehensive testing procedures.
 
-describe('AppModule', () => {
-  it('should create instance', async () => {
-    @Injectable()
-    class AppService {}
+## Roadmap
 
-    const appModule = await Test.createModule({
-      providers: [AppService],
-    }).compile();
+See [`ROADMAP.md`](./ROADMAP.md) for the complete feature roadmap including:
+- Current capabilities and limitations
+- Planned enhancements (Phases 2-6)
+- Effort estimates and prioritization
+- Success metrics
 
-    const appService = await appModule.get<AppService>(AppService);
-    expect(appService).toBeInstanceOf(AppService);
-  });
-});
-```
+**Highlights**:
+- **Phase 2**: Support for `@Optional()`, `@Global()`, property injection, circular dependency detection
+- **Phase 3**: Quick fixes (auto-add providers, import modules, fix type mismatches)
+- **Phase 4**: Refactoring support (rename tokens, extract to module)
+- **Phase 5**: Performance optimizations, hover info, inlay hints
+- **Phase 6**: Dependency graph visualization, testing support
 
 ## License
 

package/dist/actions/get-completion-info.actions.js

@@ -2,23 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCompletionInfoActions = void 0;
 const tslib_1 = require("tslib");
+const type_checker_1 = require("@nexus-ioc/type-checker");
 const tsserverlibrary_1 = tslib_1.__importDefault(require("typescript/lib/tsserverlibrary"));
-const find_type_references_helper_1 = require("../helpers/find-type-references.helper");
-const ns_module_parser_1 = require("../parsers/ns-module.parser");
-const ns_modules_parser_1 = require("../parsers/ns-modules.parser");
 const getCompletionInfoActions = (classDeclaration, tsNsLs) => {
     const typeChecker = tsNsLs.tsLS.getProgram()?.getTypeChecker();
     if (!typeChecker) {
         return;
     }
-    const entries = (0, find_type_references_helper_1.findTypeReferences)(classDeclaration, tsNsLs.tsLS, tsNsLs.logger)
+    const entries = (0, type_checker_1.findTypeReferences)(classDeclaration, tsNsLs)
         .map((item) => {
         const sourceFile = tsNsLs.tsLS
             .getProgram()
             ?.getSourceFile(item.fileName);
-        return ns_modules_parser_1.NsModulesParser.executeByClassDependency(sourceFile, classDeclaration, tsNsLs.logger);
+        return type_checker_1.ModulesParser.executeByClassDependency(sourceFile, classDeclaration, tsNsLs);
     })
-        .flatMap((items) => ns_module_parser_1.NsModuleParser.execute(items, typeChecker, tsNsLs.logger))
+        .flatMap((items) => type_checker_1.ModuleParser.execute(items, typeChecker, tsNsLs))
         .flatMap((module) => module.providers)
         .map((provider, index) => {
         if (tsserverlibrary_1.default.isStringLiteral(provider.provide)) {

package/dist/actions/get-completion-info.actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-completion-info.actions.js","sourceRoot":"","sources":["../../src/actions/get-completion-info.actions.ts"],"names":[],"mappings":";;;;AACA,6FAAgD;AAChD,wFAA4E;AAE5E,kEAA6D;AAC7D,oEAA+D;AAExD,MAAM,wBAAwB,GAAG,CACvC,gBAAqC,EACrC,MAAyB,EACO,EAAE;IAClC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,CAAC;IAE/D,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO;IACR,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,gDAAkB,EACjC,gBAAgB,EAChB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,MAAM,CACb;SACC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI;aAC5B,UAAU,EAAE;YACb,EAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAkB,CAAC;QACjD,OAAO,mCAAe,CAAC,wBAAwB,CAC9C,UAAU,EACV,gBAAgB,EAChB,MAAM,CAAC,MAAM,CACb,CAAC;IACH,CAAC,CAAC;SACD,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAClB,iCAAc,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,CACzD;SACA,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC;SACrC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAA0B,EAAE;QAChD,IAAI,yBAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO;iBAC3B,OAAO,EAAE;iBACT,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;iBACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAEtB,OAAO;gBACN,IAAI;gBACJ,IAAI,EAAE,yBAAE,CAAC,iBAAiB,CAAC,MAAM;gBACjC,aAAa,EAAE,QAAQ;gBACvB,QAAQ,EAAE,GAAG,KAAK,EAAE;gBACpB,UAAU,EAAE,IAAI;aAChB,CAAC;QACH,CAAC;QAED,IAAI,yBAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACN,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAc;gBAC3C,IAAI,EAAE,yBAAE,CAAC,iBAAiB,CAAC,YAAY;gBACvC,aAAa,EAAE,QAAQ;gBACvB,QAAQ,EAAE,GAAG,KAAK,EAAE;gBACpB,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAc;aACjD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAElB,OAAO;QACN,kBAAkB,EAAE,KAAK;QACzB,kBAAkB,EAAE,IAAI;QACxB,uBAAuB,EAAE,IAAI;QAC7B,OAAO,EAAE,OAA4B;KACrC,CAAC;AACH,CAAC,CAAC;AAjEW,QAAA,wBAAwB,4BAiEnC"}
+{"version":3,"file":"get-completion-info.actions.js","sourceRoot":"","sources":["../../src/actions/get-completion-info.actions.ts"],"names":[],"mappings":";;;;AAAA,0DAIiC;AAEjC,6FAAgD;AAGzC,MAAM,wBAAwB,GAAG,CACvC,gBAAqC,EACrC,MAAyB,EACO,EAAE;IAClC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,cAAc,EAAE,CAAC;IAE/D,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO;IACR,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,iCAAkB,EAAC,gBAAgB,EAAE,MAAM,CAAC;SAC1D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI;aAC5B,UAAU,EAAE;YACb,EAAE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAkB,CAAC;QACjD,OAAO,4BAAa,CAAC,wBAAwB,CAC5C,UAAU,EACV,gBAAgB,EAChB,MAAM,CACN,CAAC;IACH,CAAC,CAAC;SACD,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,2BAAY,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;SACpE,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC;SACrC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAA0B,EAAE;QAChD,IAAI,yBAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO;iBAC3B,OAAO,EAAE;iBACT,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;iBACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAEtB,OAAO;gBACN,IAAI;gBACJ,IAAI,EAAE,yBAAE,CAAC,iBAAiB,CAAC,MAAM;gBACjC,aAAa,EAAE,QAAQ;gBACvB,QAAQ,EAAE,GAAG,KAAK,EAAE;gBACpB,UAAU,EAAE,IAAI;aAChB,CAAC;QACH,CAAC;QAED,IAAI,yBAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,OAAO;gBACN,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAc;gBAC3C,IAAI,EAAE,yBAAE,CAAC,iBAAiB,CAAC,YAAY;gBACvC,aAAa,EAAE,QAAQ;gBACvB,QAAQ,EAAE,GAAG,KAAK,EAAE;gBACpB,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAc;aACjD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAElB,OAAO;QACN,kBAAkB,EAAE,KAAK;QACzB,kBAAkB,EAAE,IAAI;QACxB,uBAAuB,EAAE,IAAI;QAC7B,OAAO,EAAE,OAA4B;KACrC,CAAC;AACH,CAAC,CAAC;AA3DW,QAAA,wBAAwB,4BA2DnC"}

package/dist/actions/get-semantic-diagnostics.actions.d.ts

@@ -1,3 +1,16 @@
 import * as ts from "typescript/lib/tsserverlibrary";
 import type { NsLanguageService } from "../language-service/ns-language-service";
+/**
+ * Generates semantic diagnostics for Nexus IoC dependency injection
+ *
+ * Analyzes @Injectable classes and their @Inject decorators to detect:
+ * - Missing dependencies (not provided in any module)
+ * - Type mismatches between injected and provided types
+ * - Services not connected to any module
+ * - Circular dependencies
+ *
+ * @param fileName - The source file to analyze
+ * @param tsNsLs - The Nexus IoC Language Service instance
+ * @returns Array of TypeScript diagnostics including original diagnostics and DI-specific errors
+ */
 export declare const getSemanticDiagnosticsActions: (fileName: string, tsNsLs: NsLanguageService) => ts.Diagnostic[];