Merge pull request #327 from inversify/feat/update-next-getting-start…

…ed-docs-page

Update next getting started docs page

packages/docs/services/inversify-site/docs/introduction/getting-started.mdx

@@ -3,14 +3,14 @@ sidebar_position: 1
 title: Getting started
 ---
 import CodeBlock from '@theme/CodeBlock';
-import gettingStartedSource from '@inversifyjs/code-examples/generated/examples/gettingStarted.ts.txt';
+import gettingStartedSource from '@inversifyjs/code-examples/generated/examples/v7/gettingStarted.ts.txt';
 
 # Getting started
 
 Start by installing `inversify` and `reflect-metadata`:
 
 ```bash
-npm install inversify reflect-metadata
+npm install inversify@alpha reflect-metadata
 ```
 
 Next, initialize your first container and add some bindings:

packages/docs/tools/inversify-code-examples/README.md

@@ -5,9 +5,9 @@ Inversify docs code examples.
 ## Adding code examples
 
 1. Just create your code example in the `src/examples` folder with an integration test to verify the expected behavior.
-2. Use a `// Begin-example` comment to set the begining of the example.
-3. Use a `// Exclude-from-example` comment to exclude a sentence from the example.
-4. Use a `// End-example` comment to set the end of the example.
-
+  - Use a `// Begin-example` comment to set the begining of the example.
+  - Use a `// Exclude-from-example` comment to exclude a sentence from the example.
+  - Use a `// Is-inversify-import-example` comment to normalize inversify imports.
+  - Use a `// End-example` comment to set the end of the example.
 2. Run the `build` script.
 3. Your code example will be available in the `generated/examples` folder.

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingOnSyntaxApiOnActivation.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable, ResolutionContext } from 'inversify7';
 
 const container: Container = new Container();

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingScopeRequest.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingScopeSingleton.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingScopeTransient.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiTo.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToConstantValue.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToDynamicValue.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToFactory.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import {
   Container,
   Factory,

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToProvider.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-magic-numbers */
+// Is-inversify-import-example
 import { Container, injectable, ResolutionContext } from 'inversify7';
 
 // Begin-example

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToSelf.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingToSyntaxApiToService.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface CardCatalogProvider<TCard> {

packages/docs/tools/inversify-code-examples/src/examples/v7/bindingWhenSyntaxApiWhen.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import {
   BindingMetadata,
   Container,

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiGet.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiGetAll.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiGetAllAsync.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiGetAsync.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 @injectable()

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiIsBound.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 // Begin-example

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiIsCurrentBound.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable } from 'inversify7';
 
 // Begin-example

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiOnActivation.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-magic-numbers */
+// Is-inversify-import-example
 import { Container, ResolutionContext } from 'inversify7';
 
 // Begin-example

packages/docs/tools/inversify-code-examples/src/examples/v7/containerApiOnDeactivation.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 void (async () => {

packages/docs/tools/inversify-code-examples/src/examples/v7/containerModuleApiExample.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
+// Is-inversify-import-example
 import {
   Container,
   ContainerModule,

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiInjectConstructorArgument.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject, injectable } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiInjectProperty.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject, injectable } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiMultiInjectProperty.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable, multiInject } from 'inversify7';
 
 export interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiNamed.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject, injectable, named } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiOptional.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject, injectable, optional } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiPostConstruct.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-magic-numbers */
+// Is-inversify-import-example
 import { Container, postConstruct } from 'inversify7';
 
 // Begin-example

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiPreDestroy.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, preDestroy } from 'inversify7';
 
 void (async () => {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiTagged.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, inject, injectable, tagged } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/decoratorApiUnmanaged.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container, injectable, unmanaged } from 'inversify7';
 
 @injectable()

packages/docs/tools/inversify-code-examples/src/examples/v7/fundamentalsBindingExample.ts

@@ -1,3 +1,4 @@
+// Is-inversify-import-example
 import { Container } from 'inversify7';
 
 interface Weapon {

packages/docs/tools/inversify-code-examples/src/examples/v7/gettingStarted.int.spec.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from '@jest/globals';
+
+import { ninja } from './gettingStarted';
+
+describe('getting started', () => {
+  it('should provide a ninja with a weapon with right damage', () => {
+    expect(ninja.katana.damage).toBe(10);
+  });
+});

packages/docs/tools/inversify-code-examples/src/examples/v7/gettingStarted.ts

@@ -0,0 +1,27 @@
+// Is-inversify-import-example
+import { Container, inject, injectable } from 'inversify7';
+
+@injectable()
+class Katana {
+  public readonly damage: number = 10;
+}
+
+@injectable()
+class Ninja {
+  constructor(
+    @inject(Katana)
+    public readonly katana: Katana,
+  ) {}
+}
+
+const container: Container = new Container();
+
+container.bind(Ninja).toSelf();
+container.bind(Katana).toSelf();
+
+const ninja: Ninja = container.get(Ninja);
+
+console.log(ninja.katana.damage); // Prints 10
+// End-example
+
+export { ninja };