[#208] Rename templates and skeleton folders

CONTRIBUTING.md

@@ -49,13 +49,13 @@ The project has the following main files and folders:
 ├── bin # the executable file for the CLI
 │   ├── dev # the executable file for the CLI in development mode
 │   └── run # the executable file for the CLI in production mode
-├── skeleton # the skeleton files for the project
-│   ├── addons # the skeleton files for common addons e.g. version control, CI/CD, etc.
-│   │   ├── aws # the skeleton files for AWS modules
-│   │   └── versionControl # the skeleton files for version control
-│   └── core # the skeleton folders
-│       ├── base # the skeleton files for the base folder
-│       └── shared # the skeleton files for the shared folder
+├── templates # the templates files for the project
+│   ├── addons # the templates files for common addons e.g. version control, CI/CD, etc.
+│   │   ├── aws # the templates files for AWS modules
+│   │   └── versionControl # the templates files for version control
+│   └── core # the templates folders
+│       ├── base # the templates files for the base folder
+│       └── shared # the templates files for the shared folder
 ├── src # the source code of the CLI
 │   ├── commands # the commands of the CLI
 │   │   ├── generate
@@ -78,13 +78,13 @@ The project has the following main files and folders:
 ```
 
 > [!NOTE]\
-> The `skeleton` folder and the `templates` folder are the two main folders that are used to generate the project files
+> The `templates` folder and the `templates` folder are the two main folders that are used to generate the project files
 
-- The `skeleton` folder contains the addon's files and folders ready to be directly copy-pasted into the generated project if the related addon has been selected. These files serve as a starting point or "skeleton" for the specific addon.
+- The `templates` folder contains the addon's files and folders ready to be directly copy-pasted into the generated project if the related addon has been selected. These files serve as a starting point or "templates" for the specific addon.
 
 - On the other hand, the `templates` folder houses the logic for determining which files need to be copied from the templates folder into the core project files. It includes instructions on what files should be formed based on the type of addon/module being added (common addons, AWS modules, or standard files).
 
-In summary, while the `skeleton` folder provides the files and folders needed for the addon, the `templates` folder handles the dynamic copying and integration of those files within the core project structure.
+In summary, while the `templates` folder provides the files and folders needed for the addon, the `templates` folder handles the dynamic copying and integration of those files within the core project structure.
 
 ### Add a new command
 
@@ -104,8 +104,8 @@ To add a new addon or module, follow these steps:
 
 Inside the newly created addon/module folder, you can include the code required to generate the templates.
 
-3. Navigate to the `skeleton` folder at the same level as the `src` folder in the project directory.
-4. Add the skeleton folders/files for the addon/module that you are adding inside the corresponding folder in the `skeleton` directory.
+3. Navigate to the `templates` folder at the same level as the `src` folder in the project directory.
+4. Add the templates folders/files for the addon/module that you are adding inside the corresponding folder in the `templates` directory.
 
 > [!NOTE]\
 > Before adding a new addon/module, it is recommended to check the existing ones for reference.

package.json

@@ -58,7 +58,7 @@
     "topics": {}
   },
   "scripts": {
-    "build": "shx rm -rf dist && tsc -b && shx cp -r skeleton dist",
+    "build": "shx rm -rf dist && tsc -b && shx cp -r templates dist",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "postpack": "shx rm -f oclif.manifest.json",

src/commands/generate/index.test.ts

@@ -32,7 +32,7 @@ describe('Generator command', () => {
         });
 
         it('creates expected directories', () => {
-          const expectedDirectories = ['.github/', 'base/', 'shared/'];
+          const expectedDirectories = ['.github/', 'core/', 'shared/'];
 
           expect(projectDir).toHaveDirectories(expectedDirectories);
         });
@@ -41,10 +41,10 @@ describe('Generator command', () => {
           const expectedFiles = [
             '.gitignore',
             '.tool-versions',
-            'base/main.tf',
-            'base/variables.tf',
-            'base/providers.tf',
-            'base/outputs.tf',
+            'core/main.tf',
+            'core/variables.tf',
+            'core/providers.tf',
+            'core/outputs.tf',
             'shared/main.tf',
             'shared/variables.tf',
             'shared/providers.tf',
@@ -107,10 +107,10 @@ describe('Generator command', () => {
           const expectedFiles = [
             '.gitignore',
             '.tool-versions',
-            'base/main.tf',
-            'base/variables.tf',
-            'base/providers.tf',
-            'base/outputs.tf',
+            'core/main.tf',
+            'core/variables.tf',
+            'core/providers.tf',
+            'core/outputs.tf',
           ];
 
           expect(projectDir).toHaveFiles(expectedFiles);

src/commands/generate/index.ts

@@ -1,14 +1,14 @@
 import { Args, Command, ux } from '@oclif/core';
 import { prompt } from 'inquirer';
 
-import { remove } from '@/helpers/file';
-import { postProcess } from '@/hooks/postProcess';
-import { generateAwsTemplate } from '@/templates/addons/aws';
+import { generateAwsTemplate } from '@/generators/addons/aws';
 import {
   applyVersionControl,
   versionControlChoices,
-} from '@/templates/addons/versionControl';
-import { applyTerraformCore } from '@/templates/core';
+} from '@/generators/addons/versionControl';
+import { applyTerraformCore } from '@/generators/terraform';
+import { remove } from '@/helpers/file';
+import { postProcess } from '@/hooks/postProcess';
 
 type GeneralOptions = {
   projectName: string;

src/commands/install/index.test.ts

@@ -41,7 +41,7 @@ describe('Install add-on command', () => {
       it('creates expected directories', () => {
         const expectedDirectories = [
           '.github/',
-          'base/',
+          'core/',
           'shared/',
           'modules/',
         ];
@@ -53,10 +53,10 @@ describe('Install add-on command', () => {
         const expectedFiles = [
           '.gitignore',
           '.tool-versions',
-          'base/main.tf',
-          'base/variables.tf',
-          'base/providers.tf',
-          'base/outputs.tf',
+          'core/main.tf',
+          'core/variables.tf',
+          'core/providers.tf',
+          'core/outputs.tf',
           'shared/main.tf',
           'shared/variables.tf',
           'shared/providers.tf',

src/commands/install/index.ts

@@ -1,8 +1,8 @@
 import { Args, Flags, Command, ux } from '@oclif/core';
 
+import { requireAwsModules } from '@/generators/addons/aws/dependencies';
+import { awsModules } from '@/generators/terraform/types';
 import { postProcess } from '@/hooks/postProcess';
-import { requireAwsModules } from '@/templates/addons/aws/dependencies';
-import { awsModules } from '@/templates/core/types';
 
 import { GeneralOptions } from '../generate';
 

src/templates/addons/aws/constants.ts → src/generators/addons/aws/constants.ts

@@ -1,13 +1,13 @@
 const AWS_DEFAULT_REGION = 'ap-southeast-1';
-const AWS_SKELETON_PATH = `addons/aws`;
+const AWS_TEMPLATE_PATH = `addons/aws`;
 const AWS_SECURITY_GROUP_PATH = `modules/security_group`;
 const AWS_SECURITY_GROUP_MAIN_PATH = `${AWS_SECURITY_GROUP_PATH}/main.tf`;
 const AWS_SECURITY_GROUP_OUTPUTS_PATH = `${AWS_SECURITY_GROUP_PATH}/outputs.tf`;
 const AWS_SECURITY_GROUP_VARIABLES_PATH = `${AWS_SECURITY_GROUP_PATH}/variables.tf`;
 
 export {
   AWS_DEFAULT_REGION,
-  AWS_SKELETON_PATH,
+  AWS_TEMPLATE_PATH,
   AWS_SECURITY_GROUP_PATH,
   AWS_SECURITY_GROUP_MAIN_PATH,
   AWS_SECURITY_GROUP_OUTPUTS_PATH,

src/templates/addons/aws/dependencies.test.ts → src/generators/addons/aws/dependencies.test.ts

@@ -1,12 +1,12 @@
 import { prompt } from 'inquirer';
 
-import { remove } from '@/helpers/file';
-import { AwsOptions } from '@/templates/addons/aws';
+import { AwsOptions } from '@/generators/addons/aws';
 import {
   applyTerraformAwsProvider,
   applyAwsVpc,
-} from '@/templates/addons/aws/modules';
-import { applyTerraformCore } from '@/templates/core';
+} from '@/generators/addons/aws/modules';
+import { applyTerraformCore } from '@/generators/terraform';
+import { remove } from '@/helpers/file';
 
 import { isAwsModuleAdded, requireAwsModules } from './dependencies';
 

src/templates/addons/aws/dependencies.ts → src/generators/addons/aws/dependencies.ts

@@ -1,8 +1,7 @@
 import { ux } from '@oclif/core';
 import { prompt } from 'inquirer';
 
-import { containsContent, isExisting } from '@/helpers/file';
-import { AwsOptions } from '@/templates/addons/aws';
+import { AwsOptions } from '@/generators/addons/aws';
 import {
   applyAwsAlb,
   applyAwsBastion,
@@ -14,14 +13,15 @@ import {
   applyAwsSecurityGroup,
   applyAwsSsm,
   applyAwsVpc,
-} from '@/templates/addons/aws/modules';
+} from '@/generators/addons/aws/modules';
+import { containsContent, isExisting } from '@/helpers/file';
 
-import { INFRA_BASE_MAIN_PATH } from '../../core/constants';
+import { INFRA_CORE_MAIN_PATH } from '../../terraform/constants';
 import {
   AwsModule,
   AwsModuleName,
   InstallationOptions,
-} from '../../core/types';
+} from '../../terraform/types';
 
 const AWS_MODULES: Record<AwsModuleName | string, AwsModule> = {
   vpc: {
@@ -98,7 +98,7 @@ const isAwsModuleAdded = (
 
   const isModuleExisting = isExisting(module.path, projectName);
   const isModuleAdded = containsContent(
-    INFRA_BASE_MAIN_PATH,
+    INFRA_CORE_MAIN_PATH,
     module.mainContent,
     projectName
   );

src/templates/addons/aws/modules/alb.test.ts → src/generators/addons/aws/modules/alb.test.ts

@@ -1,6 +1,6 @@
+import { AwsOptions } from '@/generators/addons/aws';
+import { applyTerraformCore } from '@/generators/terraform';
 import { remove } from '@/helpers/file';
-import { AwsOptions } from '@/templates/addons/aws';
-import { applyTerraformCore } from '@/templates/core';
 
 import applyAwsAlb, {
   albModuleContent,
@@ -40,10 +40,10 @@ describe('ALB add-on', () => {
 
     it('creates expected files', () => {
       const expectedFiles = [
-        'base/main.tf',
-        'base/providers.tf',
-        'base/outputs.tf',
-        'base/variables.tf',
+        'core/main.tf',
+        'core/providers.tf',
+        'core/outputs.tf',
+        'core/variables.tf',
         'modules/alb/main.tf',
         'modules/alb/variables.tf',
       ];
@@ -52,19 +52,19 @@ describe('ALB add-on', () => {
     });
 
     it('adds ALB module to main.tf', () => {
-      expect(projectDir).toHaveContentInFile('base/main.tf', albModuleContent);
+      expect(projectDir).toHaveContentInFile('core/main.tf', albModuleContent);
     });
 
     it('adds ALB variables to variables.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'base/variables.tf',
+        'core/variables.tf',
         albVariablesContent
       );
     });
 
     it('adds ALB outputs to outputs.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'base/outputs.tf',
+        'core/outputs.tf',
         albOutputsContent
       );
     });

src/templates/addons/aws/modules/alb.ts → src/generators/addons/aws/modules/alb.ts

@@ -1,21 +1,21 @@
 import { dedent } from 'ts-dedent';
 
-import { appendToFile, copy } from '@/helpers/file';
-import { AwsOptions } from '@/templates/addons/aws';
+import { AwsOptions } from '@/generators/addons/aws';
 import {
   isAwsModuleAdded,
   requireAwsModules,
-} from '@/templates/addons/aws/dependencies';
+} from '@/generators/addons/aws/dependencies';
 import {
-  INFRA_BASE_MAIN_PATH,
-  INFRA_BASE_OUTPUTS_PATH,
-  INFRA_BASE_VARIABLES_PATH,
-} from '@/templates/core/constants';
+  INFRA_CORE_MAIN_PATH,
+  INFRA_CORE_OUTPUTS_PATH,
+  INFRA_CORE_VARIABLES_PATH,
+} from '@/generators/terraform/constants';
+import { appendToFile, copy } from '@/helpers/file';
 
 import {
   AWS_SECURITY_GROUP_MAIN_PATH,
   AWS_SECURITY_GROUP_OUTPUTS_PATH,
-  AWS_SKELETON_PATH,
+  AWS_TEMPLATE_PATH,
 } from '../constants';
 
 const albVariablesContent = dedent`
@@ -103,14 +103,14 @@ const applyAwsAlb = async (options: AwsOptions) => {
   }
   await requireAwsModules('alb', 'securityGroup', options);
 
-  copy(`${AWS_SKELETON_PATH}/modules/alb`, 'modules/alb', options.projectName);
-  appendToFile(INFRA_BASE_MAIN_PATH, albModuleContent, options.projectName);
+  copy(`${AWS_TEMPLATE_PATH}/modules/alb`, 'modules/alb', options.projectName);
+  appendToFile(INFRA_CORE_MAIN_PATH, albModuleContent, options.projectName);
   appendToFile(
-    INFRA_BASE_VARIABLES_PATH,
+    INFRA_CORE_VARIABLES_PATH,
     albVariablesContent,
     options.projectName
   );
-  appendToFile(INFRA_BASE_OUTPUTS_PATH, albOutputsContent, options.projectName);
+  appendToFile(INFRA_CORE_OUTPUTS_PATH, albOutputsContent, options.projectName);
   appendToFile(
     AWS_SECURITY_GROUP_MAIN_PATH,
     albSGMainContent,

src/templates/addons/aws/modules/bastion.test.ts → src/generators/addons/aws/modules/bastion.test.ts

@@ -1,6 +1,6 @@
+import { AwsOptions } from '@/generators/addons/aws';
+import { applyTerraformCore } from '@/generators/terraform';
 import { remove } from '@/helpers/file';
-import { AwsOptions } from '@/templates/addons/aws';
-import { applyTerraformCore } from '@/templates/core';
 
 import applyAwsBastion, {
   bastionModuleContent,
@@ -39,10 +39,10 @@ describe('Bastion add-on', () => {
 
     it('creates expected files', () => {
       const expectedFiles = [
-        'base/main.tf',
-        'base/providers.tf',
-        'base/outputs.tf',
-        'base/variables.tf',
+        'core/main.tf',
+        'core/providers.tf',
+        'core/outputs.tf',
+        'core/variables.tf',
         'modules/bastion/main.tf',
         'modules/bastion/variables.tf',
       ];
@@ -52,14 +52,14 @@ describe('Bastion add-on', () => {
 
     it('adds bastion module to main.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'base/main.tf',
+        'core/main.tf',
         bastionModuleContent
       );
     });
 
     it('adds bastion variables to variables.tf', () => {
       expect(projectDir).toHaveContentInFile(
-        'base/variables.tf',
+        'core/variables.tf',
         bastionVariablesContent
       );
     });