refactor: 💡 (setup) adjust starter structure

Author: nivekcode

Diff for: angular.json

@@ -3,61 +3,61 @@
   "version": 1,
   "newProjectRoot": "projects",
   "projects": {
-    "ngIfResponsive": {
+    "angularLibraryStarter": {
       "projectType": "library",
-      "root": "projects/ng-if-responsive",
-      "sourceRoot": "projects/ng-if-responsive/src",
+      "root": "projects/angular-library-starter",
+      "sourceRoot": "projects/angular-library-starter/src",
       "prefix": "lib",
       "architect": {
         "build": {
           "builder": "@angular-devkit/build-angular:ng-packagr",
           "options": {
-            "project": "projects/ng-if-responsive/ng-package.json"
+            "project": "projects/angular-library-starter/ng-package.json"
           },
           "configurations": {
             "production": {
-              "tsConfig": "projects/ng-if-responsive/tsconfig.lib.prod.json"
+              "tsConfig": "projects/angular-library-starter/tsconfig.lib.prod.json"
             },
             "development": {
-              "tsConfig": "projects/ng-if-responsive/tsconfig.lib.json"
+              "tsConfig": "projects/angular-library-starter/tsconfig.lib.json"
             }
           },
           "defaultConfiguration": "production"
         },
         "test": {
           "builder": "@angular-builders/jest:run",
           "options": {
-            "tsConfig": "projects/ng-if-responsive/tsconfig.spec.json"
+            "tsConfig": "projects/angular-library-starter/tsconfig.spec.json"
           }
         }
       }
     },
-    "ngIfResponsiveShowcase": {
+    "angularLibraryStarterShowcase": {
       "projectType": "application",
       "schematics": {
         "@schematics/angular:component": {
           "style": "scss"
         }
       },
-      "root": "projects/ng-if-responsive-showcase",
-      "sourceRoot": "projects/ng-if-responsive-showcase/src",
+      "root": "projects/angular-library-starter-showcase",
+      "sourceRoot": "projects/angular-library-starter-showcase/src",
       "prefix": "app",
       "architect": {
         "build": {
           "builder": "@angular-devkit/build-angular:browser",
           "options": {
-            "outputPath": "dist/ng-if-responsive-showcase",
-            "index": "projects/ng-if-responsive-showcase/src/index.html",
-            "main": "projects/ng-if-responsive-showcase/src/main.ts",
-            "polyfills": "projects/ng-if-responsive-showcase/src/polyfills.ts",
-            "tsConfig": "projects/ng-if-responsive-showcase/tsconfig.app.json",
+            "outputPath": "dist/angular-library-starter-showcase",
+            "index": "projects/angular-library-starter-showcase/src/index.html",
+            "main": "projects/angular-library-starter-showcase/src/main.ts",
+            "polyfills": "projects/angular-library-starter-showcase/src/polyfills.ts",
+            "tsConfig": "projects/angular-library-starter-showcase/tsconfig.app.json",
             "inlineStyleLanguage": "scss",
             "assets": [
-              "projects/ng-if-responsive-showcase/src/favicon.ico",
-              "projects/ng-if-responsive-showcase/src/assets"
+              "projects/angular-library-starter-showcase/src/favicon.ico",
+              "projects/angular-library-starter-showcase/src/assets"
             ],
             "styles": [
-              "projects/ng-if-responsive-showcase/src/styles.scss"
+              "projects/angular-library-starter-showcase/src/styles.scss"
             ],
             "scripts": []
           },
@@ -77,8 +77,8 @@
               ],
               "fileReplacements": [
                 {
-                  "replace": "projects/ng-if-responsive-showcase/src/environments/environment.ts",
-                  "with": "projects/ng-if-responsive-showcase/src/environments/environment.prod.ts"
+                  "replace": "projects/angular-library-starter-showcase/src/environments/environment.ts",
+                  "with": "projects/angular-library-starter-showcase/src/environments/environment.prod.ts"
                 }
               ],
               "outputHashing": "all"
@@ -98,30 +98,30 @@
           "builder": "@angular-devkit/build-angular:dev-server",
           "configurations": {
             "production": {
-              "browserTarget": "ngIfResponsiveShowcase:build:production"
+              "browserTarget": "angularLibraryStarterShowcase:build:production"
             },
             "development": {
-              "browserTarget": "ngIfResponsiveShowcase:build:development"
+              "browserTarget": "angularLibraryStarterShowcase:build:development"
             }
           },
           "defaultConfiguration": "development"
         },
         "extract-i18n": {
           "builder": "@angular-devkit/build-angular:extract-i18n",
           "options": {
-            "browserTarget": "ngIfResponsiveShowcase:build"
+            "browserTarget": "angularLibraryStarterShowcase:build"
           }
         },
         "test": {
           "builder": "@angular-builders/jest:run",
           "options": {
-            "tsConfig": "projects/ng-if-responsive-showcase/tsconfig.spec.json",
+            "tsConfig": "projects/angular-library-starter-showcase/tsconfig.spec.json",
             "assets": [
-              "projects/ng-if-responsive-showcase/src/favicon.ico",
-              "projects/ng-if-responsive-showcase/src/assets"
+              "projects/angular-library-starter-showcase/src/favicon.ico",
+              "projects/angular-library-starter-showcase/src/assets"
             ],
             "styles": [
-              "projects/ng-if-responsive-showcase/src/styles.scss"
+              "projects/angular-library-starter-showcase/src/styles.scss"
             ],
             "scripts": []
           }
@@ -132,4 +132,4 @@
   "cli": {
     "analytics": false
   }
-}
+}

Diff for: package-lock.json

@@ -1,22 +1,22 @@
 {
-  "name": "ng-if-responsive",
+  "name": "angular-library-starter",
   "version": "1.0.2",
   "scripts": {
     "ng": "ng",
     "start": "ng serve -o",
     "build": "npm run build:library && npm run build:showcase",
-    "build:library": "ng build --project=ngIfResponsive && npm run copy-readme",
-    "build:showcase": "ng build --project=ngIfResponsiveShowcase --base-href ./",
+    "build:library": "ng build --project=angularLibraryStarter && npm run copy-readme",
+    "build:showcase": "ng build --project=angularLibraryStarterShowcase --base-href ./",
     "bump-version": "rjp package.json version $VERSION",
-    "copy-readme": "copyfiles README.md dist/ng-if-responsive",
+    "copy-readme": "copyfiles README.md dist/angular-library-starter",
     "customize": "node tools/customization.mjs",
     "lint": "eslint projects/**/*.ts",
     "lint-staged": "lint-staged --allow-empty",
     "commitlint": "commitlint --edit",
-    "watch:library": "jest --config projects/ng-if-responsive/jest.config.js --watch",
-    "test:library": "jest --config projects/ng-if-responsive/jest.config.js",
-    "test:showcase": "jest --config projects/ng-if-responsive-showcase/jest.config.js",
-    "coverage:library": "jest --config projects/ng-if-responsive/jest.config.js --coverage --coverageDirectory=../../.coverage",
+    "watch:library": "jest --config projects/angular-library-starter/jest.config.js --watch",
+    "test:library": "jest --config projects/angular-library-starter/jest.config.js",
+    "test:showcase": "jest --config projects/angular-library-starter-showcase/jest.config.js",
+    "coverage:library": "jest --config projects/angular-library-starter/jest.config.js --coverage --coverageDirectory=../../.coverage",
     "format:test": "prettier --list-different 'projects/**/*.{ts,html}'",
     "format:write": "prettier --write 'projects/**/*.{ts,html}'",
     "prepare": "husky install"

Diff for: package.json

@@ -1,6 +1,6 @@
 <nav class="bg-blue-900 h-16 pl-5 flex items-center">
   <div class="flex items-baseline">
-    <h1 class="text-3xl text-white">ngIfResponsive</h1>
+    <h1 class="text-3xl text-white">angular-library-starter</h1>
     <h2 class="text-lg text-white pl-2">Showcase</h2>
   </div>
 </nav>
@@ -10,5 +10,7 @@ <h2 class="text-lg text-white pl-2">Showcase</h2>
     "Start building an epic Angular library and showcase it here"
   </blockquote>
 
-  <ng-if-responsive-sample class="text-xl"></ng-if-responsive-sample>
+  <angular-library-starter-sample
+    class="text-xl"
+  ></angular-library-starter-sample>
 </div>

Diff for: projects/ng-if-responsive-showcase/jest.config.js renamed to projects/angular-library-starter-showcase/jest.config.js

@@ -2,13 +2,17 @@ import { NgModule } from '@angular/core';
 import { BrowserModule } from '@angular/platform-browser';
 import { HIGHLIGHT_OPTIONS, HighlightModule } from 'ngx-highlightjs';
 
-import { NgIfResponsiveSampleComponent } from '../../../ng-if-responsive/src/lib/sample.component';
+import { AngularLibraryStarterSampleComponent } from '../../../angular-library-starter/src/lib/sample.component';
 
 import { AppComponent } from './app.component';
 
 @NgModule({
   declarations: [AppComponent],
-  imports: [BrowserModule, HighlightModule, NgIfResponsiveSampleComponent],
+  imports: [
+    BrowserModule,
+    HighlightModule,
+    AngularLibraryStarterSampleComponent,
+  ],
   providers: [
     {
       provide: HIGHLIGHT_OPTIONS,

Diff for: projects/ng-if-responsive-showcase/src/app/app.component.html renamed to projects/angular-library-starter-showcase/src/app/app.component.html

@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <title>NgIfResponsiveShowcase</title>
+    <title>AngularLibraryStarterShowcase</title>
     <base href="/" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <link rel="icon" type="image/x-icon" href="favicon.ico" />

Diff for: projects/ng-if-responsive-showcase/src/assets/.gitkeep renamed to projects/angular-library-starter-showcase/src/app/app.component.scss

@@ -5,11 +5,6 @@
     "outDir": "../../out-tsc/app",
     "types": []
   },
-  "files": [
-    "src/main.ts",
-    "src/polyfills.ts"
-  ],
-  "include": [
-    "src/**/*.d.ts"
-  ]
+  "files": ["src/main.ts", "src/polyfills.ts"],
+  "include": ["src/**/*.d.ts"]
 }

Diff for: projects/ng-if-responsive-showcase/src/app/app.component.ts renamed to projects/angular-library-starter-showcase/src/app/app.component.ts

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/spec",
+    "types": ["jest"]
+  },
+  "files": ["src/polyfills.ts"],
+  "include": ["src/**/*.spec.ts", "src/**/*.d.ts"]
+}

Diff for: projects/ng-if-responsive-showcase/src/app/app.module.ts renamed to projects/angular-library-starter-showcase/src/app/app.module.ts

@@ -1,7 +1,7 @@
 {
   "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/ng-if-responsive",
+  "dest": "../../dist/angular-library-starter",
   "lib": {
     "entryFile": "src/public-api.ts"
   }
-}
+}

Diff for: projects/angular-library-starter-showcase/src/assets/.gitkeep

@@ -1,5 +1,5 @@
 {
-  "name": "ng-if-responsive",
+  "name": "angular-library-starter",
   "version": "1.0.0",
   "peerDependencies": {
     "@angular/common": "^15.0.4",

Diff for: projects/ng-if-responsive-showcase/src/environments/environment.prod.ts renamed to projects/angular-library-starter-showcase/src/environments/environment.prod.ts

@@ -1,15 +1,15 @@
 import { ChangeDetectionStrategy, Component } from '@angular/core';
 
-import { NgIfResponsiveSampleService } from './sample.service';
+import { AngularLibraryStarterSampleService } from './sample.service';
 
 @Component({
-  selector: 'ng-if-responsive-sample',
+  selector: 'angular-library-starter-sample',
   template: `<h1>
     The best framework is {{ sampleService.getBestFramework() }}
   </h1>`,
   standalone: true,
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
-export class NgIfResponsiveSampleComponent {
-  constructor(public sampleService: NgIfResponsiveSampleService) {}
+export class AngularLibraryStarterSampleComponent {
+  constructor(public sampleService: AngularLibraryStarterSampleService) {}
 }

Diff for: projects/ng-if-responsive-showcase/src/environments/environment.ts renamed to projects/angular-library-starter-showcase/src/environments/environment.ts

@@ -1,10 +1,10 @@
-import { NgIfResponsiveSampleService } from './sample.service';
+import { AngularLibraryStarterSampleService } from './sample.service';
 
 describe('Sample Service', () => {
-  let sut: NgIfResponsiveSampleService;
+  let sut: AngularLibraryStarterSampleService;
 
   beforeEach(() => {
-    sut = new NgIfResponsiveSampleService();
+    sut = new AngularLibraryStarterSampleService();
   });
 
   it('should know that Angular is the best framework', () => {

Diff for: projects/ng-if-responsive-showcase/src/favicon.ico renamed to projects/angular-library-starter-showcase/src/favicon.ico

@@ -3,7 +3,7 @@ import { Injectable } from '@angular/core';
 @Injectable({
   providedIn: 'root',
 })
-export class NgIfResponsiveSampleService {
+export class AngularLibraryStarterSampleService {
   public getBestFramework(): string {
     return 'Angular';
   }

Diff for: projects/ng-if-responsive-showcase/src/index.html renamed to projects/angular-library-starter-showcase/src/index.html

@@ -0,0 +1,4 @@
+/*
+ * Public API Surface of angular-library-starter
+ */
+export * from './lib/sample.component';

Diff for: projects/ng-if-responsive-showcase/src/main.ts renamed to projects/angular-library-starter-showcase/src/main.ts

@@ -8,8 +8,5 @@
     "inlineSources": true,
     "types": []
   },
-  "exclude": [
-    "src/test.ts",
-    "**/*.spec.ts"
-  ]
+  "exclude": ["src/test.ts", "**/*.spec.ts"]
 }

Diff for: projects/ng-if-responsive-showcase/src/polyfills.ts renamed to projects/angular-library-starter-showcase/src/polyfills.ts

@@ -2,13 +2,8 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "../../out-tsc/spec",
-    "types": [
-      "jest"
-    ]
+    "types": ["jest"]
   },
   "files": [],
-  "include": [
-    "**/*.spec.ts",
-    "**/*.d.ts"
-  ]
+  "include": ["**/*.spec.ts", "**/*.d.ts"]
 }

Diff for: projects/ng-if-responsive-showcase/src/styles.scss renamed to projects/angular-library-starter-showcase/src/styles.scss

@@ -1,8 +1,8 @@
 /** @type {import('tailwindcss').Config} */
 module.exports = {
-  content: ['./projects/ng-if-responsive-showcase/**/*.{html,ts}'],
+  content: ['./projects/angular-library-starter-showcase/**/*.{html,ts}'],
   theme: {
     extend: {},
   },
   plugins: [],
-}
+};