diff --git a/.github/workflows/publish-lib.yml b/.github/workflows/publish-lib.yml index 14b8a22e..abc8323d 100644 --- a/.github/workflows/publish-lib.yml +++ b/.github/workflows/publish-lib.yml @@ -15,4 +15,4 @@ jobs: - uses: JS-DevTools/npm-publish@v3 with: token: ${{ secrets.NPM_AUTH_TOKEN }} - package: ./dist/neo-standalone-components/package.json + package: ./dist/examples/package.json diff --git a/README.md b/README.md index a3bdbba3..976e5f69 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The appli ## Code scaffolding -Run `ng generate component component-name --project neo-standalone-components` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project neo-standalone-components`. +Run `ng generate component component-name --project examples` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project examples`. -> Note: Don't forget to add `--project neo-standalone-components` or else it will be added to the default project in your `angular.json` file. +> Note: Don't forget to add `--project examples` or else it will be added to the default project in your `angular.json` file. ## Build diff --git a/angular.json b/angular.json index 29ddb97a..62e581e0 100644 --- a/angular.json +++ b/angular.json @@ -3,23 +3,23 @@ "version": 1, "newProjectRoot": "projects", "projects": { - "neo-standalone-components": { + "examples": { "projectType": "library", - "root": "projects/neo-standalone-components", - "sourceRoot": "projects/neo-standalone-components/src", + "root": "projects/examples", + "sourceRoot": "projects/examples/src", "prefix": "lib", "architect": { "build": { "builder": "@angular-devkit/build-angular:ng-packagr", "options": { - "project": "projects/neo-standalone-components/ng-package.json" + "project": "projects/examples/ng-package.json" }, "configurations": { "production": { - "tsConfig": "projects/neo-standalone-components/tsconfig.lib.prod.json" + "tsConfig": "projects/examples/tsconfig.lib.prod.json" }, "development": { - "tsConfig": "projects/neo-standalone-components/tsconfig.lib.json" + "tsConfig": "projects/examples/tsconfig.lib.json" } }, "defaultConfiguration": "production" @@ -27,7 +27,7 @@ "test": { "builder": "@angular-devkit/build-angular:karma", "options": { - "tsConfig": "projects/neo-standalone-components/tsconfig.spec.json", + "tsConfig": "projects/examples/tsconfig.spec.json", "polyfills": [ "zone.js", "zone.js/testing" @@ -38,16 +38,16 @@ "builder": "@angular-eslint/builder:lint", "options": { "lintFilePatterns": [ - "projects/neo-standalone-components/**/*.ts", - "projects/neo-standalone-components/**/*.html" + "projects/examples/**/*.ts", + "projects/examples/**/*.html" ] } }, "storybook": { "builder": "@storybook/angular:start-storybook", "options": { - "configDir": "projects/neo-standalone-components/.storybook", - "browserTarget": "neo-standalone-components:build", + "configDir": "projects/examples/.storybook", + "browserTarget": "examples:build", "compodoc": false, "port": 6006 } @@ -55,8 +55,8 @@ "build-storybook": { "builder": "@storybook/angular:build-storybook", "options": { - "configDir": "projects/neo-standalone-components/.storybook", - "browserTarget": "neo-standalone-components:build", + "configDir": "projects/examples/.storybook", + "browserTarget": "examples:build", "compodoc": false, "outputDir": "storybook-static" } @@ -69,4 +69,4 @@ "@angular-eslint/schematics" ] } -} \ No newline at end of file +} diff --git a/package.json b/package.json index 9cef962f..fc73e620 100644 --- a/package.json +++ b/package.json @@ -4,19 +4,19 @@ "license": "SEE LICENSE IN LICENSE.md", "homepage": "https://design.avaya.com/docs/setup", "scripts": { - "storybook": "ng run neo-standalone-components:storybook", + "storybook": "ng run examples:storybook", "clean": "rm -rf .angular dist storybook-static", "lint": "ng lint", - "format": "npx prettier --write ./projects/neo-standalone-components/src --log-level warn", - "format:check": "npx prettier --check ./projects/neo-standalone-components/src --log-level warn", + "format": "npx prettier --write ./projects/examples/src --log-level warn", + "format:check": "npx prettier --check ./projects/examples/src --log-level warn", "build": "ng build", "build:netlify": "npm i && npm run build && npm run build-storybook", "build:github": "npm i && npm run lint && npm run format:check && npm run test && npm run build:release", - "build:release": "ng build neo-standalone-components --configuration production", - "build-storybook": "ng run neo-standalone-components:build-storybook", + "build:release": "ng build examples --configuration production", + "build-storybook": "ng run examples:build-storybook", "test": "ng test --browsers ChromeHeadless --watch false", "test:watch": "ng test", - "publish:lib": "npm publish ./dist/neo-standalone-components/", + "publish:lib": "npm publish ./dist/examples/", "ng": "ng", "start": "ng serve", "watch": "ng build --watch --configuration development", diff --git a/projects/neo-standalone-components/.eslintrc.json b/projects/examples/.eslintrc.json similarity index 100% rename from projects/neo-standalone-components/.eslintrc.json rename to projects/examples/.eslintrc.json diff --git a/projects/neo-standalone-components/.storybook/main.ts b/projects/examples/.storybook/main.ts similarity index 100% rename from projects/neo-standalone-components/.storybook/main.ts rename to projects/examples/.storybook/main.ts diff --git a/projects/neo-standalone-components/.storybook/preview.ts b/projects/examples/.storybook/preview.ts similarity index 100% rename from projects/neo-standalone-components/.storybook/preview.ts rename to projects/examples/.storybook/preview.ts diff --git a/projects/neo-standalone-components/.storybook/tsconfig.json b/projects/examples/.storybook/tsconfig.json similarity index 100% rename from projects/neo-standalone-components/.storybook/tsconfig.json rename to projects/examples/.storybook/tsconfig.json diff --git a/projects/neo-standalone-components/.storybook/typings.d.ts b/projects/examples/.storybook/typings.d.ts similarity index 100% rename from projects/neo-standalone-components/.storybook/typings.d.ts rename to projects/examples/.storybook/typings.d.ts diff --git a/projects/neo-standalone-components/LICENSE-3rd-party.html b/projects/examples/LICENSE-3rd-party.html similarity index 100% rename from projects/neo-standalone-components/LICENSE-3rd-party.html rename to projects/examples/LICENSE-3rd-party.html diff --git a/projects/neo-standalone-components/LICENSE.md b/projects/examples/LICENSE.md similarity index 100% rename from projects/neo-standalone-components/LICENSE.md rename to projects/examples/LICENSE.md diff --git a/projects/examples/README.md b/projects/examples/README.md new file mode 100644 index 00000000..07e4ef44 --- /dev/null +++ b/projects/examples/README.md @@ -0,0 +1,11 @@ +![github workflow status](https://github.com/avaya-dux/neo-angular-library/actions/workflows/ci.yml/badge.svg) +[![npm version](https://badge.fury.io/js/@avaya%2Fneo-angular.svg)](https://badge.fury.io/js/@avaya%2Fneo-angular) +[![Netlify Status](https://api.netlify.com/api/v1/badges/3d6c0812-28ca-4bd5-bbdf-bb2430011d28/deploy-status)](https://app.netlify.com/sites/neo-angular-library-storybook/deploys) + +# Neo Angular Component Library + +> This is the angular version of the shared library called "NEO" buit by Avaya ([storybook site](https://neo-angular-library-storybook.netlify.app/)) + +## License + +Copyright 2020-2024 Avaya Inc. All Rights Reserved. diff --git a/projects/neo-standalone-components/ng-package.json b/projects/examples/ng-package.json similarity index 71% rename from projects/neo-standalone-components/ng-package.json rename to projects/examples/ng-package.json index af62662f..c6d7dfc1 100644 --- a/projects/neo-standalone-components/ng-package.json +++ b/projects/examples/ng-package.json @@ -1,6 +1,6 @@ { "$schema": "../../node_modules/ng-packagr/ng-package.schema.json", - "dest": "../../dist/neo-standalone-components", + "dest": "../../dist/examples", "lib": { "entryFile": "src/public-api.ts" } diff --git a/projects/neo-standalone-components/package.json b/projects/examples/package.json similarity index 94% rename from projects/neo-standalone-components/package.json rename to projects/examples/package.json index c11f31cc..3230d59a 100644 --- a/projects/neo-standalone-components/package.json +++ b/projects/examples/package.json @@ -1,6 +1,6 @@ { "name": "@avaya/neo-angular", - "version": "0.0.1-alpha.6", + "version": "0.0.1-alpha.8", "description": "The component library for Avaya NEO in Angular.", "license": "SEE LICENSE IN LICENSE.md", "repository": "github:avaya-dux/neo-angular-library", diff --git a/projects/neo-standalone-components/src/lib/FauxButton/faux-button.component.ts b/projects/examples/src/lib/FauxButton/faux-button.component.ts similarity index 84% rename from projects/neo-standalone-components/src/lib/FauxButton/faux-button.component.ts rename to projects/examples/src/lib/FauxButton/faux-button.component.ts index 71f85e4b..f5a61e49 100644 --- a/projects/neo-standalone-components/src/lib/FauxButton/faux-button.component.ts +++ b/projects/examples/src/lib/FauxButton/faux-button.component.ts @@ -1,7 +1,7 @@ import { Component, Input } from "@angular/core"; @Component({ - selector: "lib-neo-standalone-components", + selector: "lib-neo-faux-button", standalone: true, template: ` `, }) diff --git a/projects/neo-standalone-components/src/lib/FauxButton/faux-button.spec.ts b/projects/examples/src/lib/FauxButton/faux-button.spec.ts similarity index 100% rename from projects/neo-standalone-components/src/lib/FauxButton/faux-button.spec.ts rename to projects/examples/src/lib/FauxButton/faux-button.spec.ts diff --git a/projects/neo-standalone-components/src/lib/FauxButton/faux-button.stories.ts b/projects/examples/src/lib/FauxButton/faux-button.stories.ts similarity index 100% rename from projects/neo-standalone-components/src/lib/FauxButton/faux-button.stories.ts rename to projects/examples/src/lib/FauxButton/faux-button.stories.ts diff --git a/projects/examples/src/lib/FauxButton/index.ts b/projects/examples/src/lib/FauxButton/index.ts new file mode 100644 index 00000000..6709065c --- /dev/null +++ b/projects/examples/src/lib/FauxButton/index.ts @@ -0,0 +1 @@ +export * from "./faux-button.component"; diff --git a/projects/examples/src/lib/Static/index.ts b/projects/examples/src/lib/Static/index.ts new file mode 100644 index 00000000..99a2834d --- /dev/null +++ b/projects/examples/src/lib/Static/index.ts @@ -0,0 +1 @@ +export * from "./static.component"; diff --git a/projects/examples/src/lib/Static/static.component.ts b/projects/examples/src/lib/Static/static.component.ts new file mode 100644 index 00000000..3b866c7d --- /dev/null +++ b/projects/examples/src/lib/Static/static.component.ts @@ -0,0 +1,9 @@ +import { Component } from "@angular/core"; + +@Component({ + selector: "lib-neo-static", + standalone: true, + imports: [], + template: `

the static component works!

`, +}) +export class StaticComponent {} diff --git a/projects/examples/src/lib/Static/static.spec.ts b/projects/examples/src/lib/Static/static.spec.ts new file mode 100644 index 00000000..1d0a7a33 --- /dev/null +++ b/projects/examples/src/lib/Static/static.spec.ts @@ -0,0 +1,22 @@ +import { ComponentFixture, TestBed } from "@angular/core/testing"; + +import { StaticComponent } from "./static.component"; + +describe("StaticComponent", () => { + let component: StaticComponent; + let fixture: ComponentFixture; + + beforeEach(async () => { + await TestBed.configureTestingModule({ + imports: [StaticComponent], + }).compileComponents(); + + fixture = TestBed.createComponent(StaticComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it("should create", () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/projects/examples/src/lib/Static/static.stories.ts b/projects/examples/src/lib/Static/static.stories.ts new file mode 100644 index 00000000..5c74e693 --- /dev/null +++ b/projects/examples/src/lib/Static/static.stories.ts @@ -0,0 +1,13 @@ +import type { Meta, StoryObj } from "@storybook/angular"; +import { StaticComponent } from "./static.component"; + +// More on how to set up stories at: https://storybook.js.org/docs/writing-stories +const meta: Meta = { + title: "Example/Static Component", + component: StaticComponent, +}; + +export default meta; +type CustomStory = StoryObj; + +export const StaticExample: CustomStory = {}; diff --git a/projects/examples/src/lib/index.ts b/projects/examples/src/lib/index.ts new file mode 100644 index 00000000..183983ba --- /dev/null +++ b/projects/examples/src/lib/index.ts @@ -0,0 +1,2 @@ +export * from "./FauxButton"; +export * from "./Static"; diff --git a/projects/examples/src/public-api.ts b/projects/examples/src/public-api.ts new file mode 100644 index 00000000..fde5d27f --- /dev/null +++ b/projects/examples/src/public-api.ts @@ -0,0 +1,5 @@ +/* + * Public API Surface of examples + */ + +export * from "./lib"; diff --git a/projects/neo-standalone-components/src/stories/.eslintrc.json b/projects/examples/src/stories/.eslintrc.json similarity index 100% rename from projects/neo-standalone-components/src/stories/.eslintrc.json rename to projects/examples/src/stories/.eslintrc.json diff --git a/projects/neo-standalone-components/src/stories/Configure.mdx b/projects/examples/src/stories/Configure.mdx similarity index 100% rename from projects/neo-standalone-components/src/stories/Configure.mdx rename to projects/examples/src/stories/Configure.mdx diff --git a/projects/neo-standalone-components/src/stories/assets/accessibility.png b/projects/examples/src/stories/assets/accessibility.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/accessibility.png rename to projects/examples/src/stories/assets/accessibility.png diff --git a/projects/neo-standalone-components/src/stories/assets/accessibility.svg b/projects/examples/src/stories/assets/accessibility.svg similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/accessibility.svg rename to projects/examples/src/stories/assets/accessibility.svg diff --git a/projects/neo-standalone-components/src/stories/assets/addon-library.png b/projects/examples/src/stories/assets/addon-library.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/addon-library.png rename to projects/examples/src/stories/assets/addon-library.png diff --git a/projects/neo-standalone-components/src/stories/assets/assets.png b/projects/examples/src/stories/assets/assets.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/assets.png rename to projects/examples/src/stories/assets/assets.png diff --git a/projects/neo-standalone-components/src/stories/assets/avif-test-image.avif b/projects/examples/src/stories/assets/avif-test-image.avif similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/avif-test-image.avif rename to projects/examples/src/stories/assets/avif-test-image.avif diff --git a/projects/neo-standalone-components/src/stories/assets/context.png b/projects/examples/src/stories/assets/context.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/context.png rename to projects/examples/src/stories/assets/context.png diff --git a/projects/neo-standalone-components/src/stories/assets/discord.svg b/projects/examples/src/stories/assets/discord.svg similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/discord.svg rename to projects/examples/src/stories/assets/discord.svg diff --git a/projects/neo-standalone-components/src/stories/assets/docs.png b/projects/examples/src/stories/assets/docs.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/docs.png rename to projects/examples/src/stories/assets/docs.png diff --git a/projects/neo-standalone-components/src/stories/assets/figma-plugin.png b/projects/examples/src/stories/assets/figma-plugin.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/figma-plugin.png rename to projects/examples/src/stories/assets/figma-plugin.png diff --git a/projects/neo-standalone-components/src/stories/assets/github.svg b/projects/examples/src/stories/assets/github.svg similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/github.svg rename to projects/examples/src/stories/assets/github.svg diff --git a/projects/neo-standalone-components/src/stories/assets/share.png b/projects/examples/src/stories/assets/share.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/share.png rename to projects/examples/src/stories/assets/share.png diff --git a/projects/neo-standalone-components/src/stories/assets/styling.png b/projects/examples/src/stories/assets/styling.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/styling.png rename to projects/examples/src/stories/assets/styling.png diff --git a/projects/neo-standalone-components/src/stories/assets/testing.png b/projects/examples/src/stories/assets/testing.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/testing.png rename to projects/examples/src/stories/assets/testing.png diff --git a/projects/neo-standalone-components/src/stories/assets/theming.png b/projects/examples/src/stories/assets/theming.png similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/theming.png rename to projects/examples/src/stories/assets/theming.png diff --git a/projects/neo-standalone-components/src/stories/assets/tutorials.svg b/projects/examples/src/stories/assets/tutorials.svg similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/tutorials.svg rename to projects/examples/src/stories/assets/tutorials.svg diff --git a/projects/neo-standalone-components/src/stories/assets/youtube.svg b/projects/examples/src/stories/assets/youtube.svg similarity index 100% rename from projects/neo-standalone-components/src/stories/assets/youtube.svg rename to projects/examples/src/stories/assets/youtube.svg diff --git a/projects/neo-standalone-components/src/stories/button.component.ts b/projects/examples/src/stories/button.component.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/button.component.ts rename to projects/examples/src/stories/button.component.ts diff --git a/projects/neo-standalone-components/src/stories/button.css b/projects/examples/src/stories/button.css similarity index 100% rename from projects/neo-standalone-components/src/stories/button.css rename to projects/examples/src/stories/button.css diff --git a/projects/neo-standalone-components/src/stories/button.stories.ts b/projects/examples/src/stories/button.stories.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/button.stories.ts rename to projects/examples/src/stories/button.stories.ts diff --git a/projects/neo-standalone-components/src/stories/header.component.ts b/projects/examples/src/stories/header.component.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/header.component.ts rename to projects/examples/src/stories/header.component.ts diff --git a/projects/neo-standalone-components/src/stories/header.css b/projects/examples/src/stories/header.css similarity index 100% rename from projects/neo-standalone-components/src/stories/header.css rename to projects/examples/src/stories/header.css diff --git a/projects/neo-standalone-components/src/stories/header.stories.ts b/projects/examples/src/stories/header.stories.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/header.stories.ts rename to projects/examples/src/stories/header.stories.ts diff --git a/projects/neo-standalone-components/src/stories/page.component.ts b/projects/examples/src/stories/page.component.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/page.component.ts rename to projects/examples/src/stories/page.component.ts diff --git a/projects/neo-standalone-components/src/stories/page.css b/projects/examples/src/stories/page.css similarity index 100% rename from projects/neo-standalone-components/src/stories/page.css rename to projects/examples/src/stories/page.css diff --git a/projects/neo-standalone-components/src/stories/page.stories.ts b/projects/examples/src/stories/page.stories.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/page.stories.ts rename to projects/examples/src/stories/page.stories.ts diff --git a/projects/neo-standalone-components/src/stories/user.ts b/projects/examples/src/stories/user.ts similarity index 100% rename from projects/neo-standalone-components/src/stories/user.ts rename to projects/examples/src/stories/user.ts diff --git a/projects/neo-standalone-components/tsconfig.lib.json b/projects/examples/tsconfig.lib.json similarity index 100% rename from projects/neo-standalone-components/tsconfig.lib.json rename to projects/examples/tsconfig.lib.json diff --git a/projects/neo-standalone-components/tsconfig.lib.prod.json b/projects/examples/tsconfig.lib.prod.json similarity index 100% rename from projects/neo-standalone-components/tsconfig.lib.prod.json rename to projects/examples/tsconfig.lib.prod.json diff --git a/projects/neo-standalone-components/tsconfig.spec.json b/projects/examples/tsconfig.spec.json similarity index 100% rename from projects/neo-standalone-components/tsconfig.spec.json rename to projects/examples/tsconfig.spec.json diff --git a/projects/neo-standalone-components/README.md b/projects/neo-standalone-components/README.md deleted file mode 100644 index d88164dc..00000000 --- a/projects/neo-standalone-components/README.md +++ /dev/null @@ -1 +0,0 @@ -[go to root readme](../../README.md) diff --git a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.spec.ts b/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.spec.ts deleted file mode 100644 index 15d14cc2..00000000 --- a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.spec.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { ComponentFixture, TestBed } from "@angular/core/testing"; - -import { NeoStandaloneComponentsComponent } from "./neo-standalone-components.component"; - -describe("NeoStandaloneComponentsComponent", () => { - let component: NeoStandaloneComponentsComponent; - let fixture: ComponentFixture; - - beforeEach(async () => { - await TestBed.configureTestingModule({ - imports: [NeoStandaloneComponentsComponent], - }).compileComponents(); - - fixture = TestBed.createComponent(NeoStandaloneComponentsComponent); - component = fixture.componentInstance; - fixture.detectChanges(); - }); - - it("should create", () => { - expect(component).toBeTruthy(); - }); -}); diff --git a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.stories.ts b/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.stories.ts deleted file mode 100644 index c9459448..00000000 --- a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.stories.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type { Meta, StoryObj } from "@storybook/angular"; -import { NeoStandaloneComponentsComponent } from "./neo-standalone-components.component"; - -// More on how to set up stories at: https://storybook.js.org/docs/writing-stories -const meta: Meta = { - title: "Example/Standalone Custom component", - component: NeoStandaloneComponentsComponent, -}; - -export default meta; -type CustomStory = StoryObj; - -export const CustomStandaloneComponentExample: CustomStory = {}; diff --git a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.ts b/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.ts deleted file mode 100644 index bd033cec..00000000 --- a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.component.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { Component } from "@angular/core"; - -@Component({ - selector: "lib-neo-standalone-components", - standalone: true, - imports: [], - template: `

neo-standalone-components works!

`, - styles: ``, -}) -export class NeoStandaloneComponentsComponent {} diff --git a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.spec.ts b/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.spec.ts deleted file mode 100644 index deb1583d..00000000 --- a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.spec.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { TestBed } from "@angular/core/testing"; - -import { NeoStandaloneComponentsService } from "./neo-standalone-components.service"; - -describe("NeoStandaloneComponentsService", () => { - let service: NeoStandaloneComponentsService; - - beforeEach(() => { - TestBed.configureTestingModule({}); - service = TestBed.inject(NeoStandaloneComponentsService); - }); - - it("should be created", () => { - expect(service).toBeTruthy(); - }); -}); diff --git a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.ts b/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.ts deleted file mode 100644 index 1300649e..00000000 --- a/projects/neo-standalone-components/src/lib/NeoStandaloneComponentsComponent/neo-standalone-components.service.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { Injectable } from "@angular/core"; - -@Injectable({ - providedIn: "root", -}) -export class NeoStandaloneComponentsService { - constructor() {} -} diff --git a/projects/neo-standalone-components/src/public-api.ts b/projects/neo-standalone-components/src/public-api.ts deleted file mode 100644 index 5eed8125..00000000 --- a/projects/neo-standalone-components/src/public-api.ts +++ /dev/null @@ -1,6 +0,0 @@ -/* - * Public API Surface of neo-standalone-components - */ - -export * from "./lib/NeoStandaloneComponentsComponent/neo-standalone-components.service"; -export * from "./lib/NeoStandaloneComponentsComponent/neo-standalone-components.component"; diff --git a/readmes/how-to-dev.md b/readmes/how-to-dev.md index 683a367a..136a5695 100644 --- a/readmes/how-to-dev.md +++ b/readmes/how-to-dev.md @@ -13,7 +13,7 @@ npm run build:release ``` -## for local development, run storybook (WIP) +## for local development, run storybook ``` npm run storybook @@ -43,6 +43,13 @@ npm run lint npm run lint --fix ``` +## when creating a new component + +- follow the naming conventions of your team +- add a folder under the `src/lib` folder +- add an `index.ts` that exports the necessary files +- add your export to the `src/lib/index.ts`; make sure to follow the alphabetical order + ## before commiting to this repo, please read - our [accessibility guidelines](./accessibility-guidelines.md) diff --git a/readmes/how-to-publish.md b/readmes/how-to-publish.md index 477ffc73..352a5001 100644 --- a/readmes/how-to-publish.md +++ b/readmes/how-to-publish.md @@ -7,14 +7,14 @@ You can check that the package was properly published by viewing it on NPMJS - [link to registry](https://registry.npmjs.org/@avaya%2fneo-angular): api call, returns JSON, no cache - [link to npmjs page](https://www.npmjs.com/package/@avaya/neo-angular): our page on NPMJS, is on a 60min cache -If you made a mistake, you can simply `unpublish` the package via +If you made a mistake, you can simply `unpublish` the package via: - `npm unpublish @avaya/neo-angular@` - - [see NPMJS docs](https://docs.npmjs.com/cli/v8/commands/npm-unpublish) for further details on unpublishing ## GitHub release -The final step is to add the release to GitHub +The final step is to add the release to GitHub. - navigate to our [GitHub releases page](https://github.com/avaya-dux/neo-angular-library/releases) - click: "Draft a new release" (top right corner) @@ -23,3 +23,12 @@ The final step is to add the release to GitHub - add title using format: "v0.1.0 (Jan 18th 2024)" - click: "Auto-generate release notes" - click: "Publish release" + + +## manual publishing + +If you need to manually publish, such as to test an alpha release, you only to build and then publish the created distrobution. + +- `npm run all`: to ensure that everything is built properly +- `npm logn`: to ensure that you are logged into NPMJS +- `npm publish ./dist/examples/`: to publish the library diff --git a/tsconfig.json b/tsconfig.json index 8056a690..b62cf435 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -11,7 +11,7 @@ "noFallthroughCasesInSwitch": true, "skipLibCheck": true, "paths": { - "neo-standalone-components": ["./dist/neo-standalone-components"] + "examples": ["./dist/examples"] }, "esModuleInterop": true, "sourceMap": true,