From 7c1b25cfcd4d18797abc9611768c6389267348d6 Mon Sep 17 00:00:00 2001 From: Ar-mane Date: Sun, 2 Jun 2024 01:31:04 +0100 Subject: [PATCH] fix: rename .json extension from config file --- README.md | 4 ++-- package.json | 4 ++-- src/constants/Constants.ts | 2 +- template/.cmrc.json | 2 +- web/src/configurations.md | 12 ++++++------ web/src/usage.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ee6fef6..391984d 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ Explore our documentation for more information on how to use Component Maker to speed up your development workflow. Detailed guides and API references are available to help you get started:

- - Read the Docs + + Read the Docs

diff --git a/package.json b/package.json index b98780e..4a129eb 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "version": "2.0.42", + "version": "2.0.43", "name": "component-maker", "displayName": "Component Maker", "publisher": "Ar-mane", "icon": "assets/images/icon.png", "license": "MIT", "description": "Generates necessary files for new components, does not depend on any language, framework", - "homepage": "https://component-maker.vercel.app/", + "homepage": "https://cm.armane.dev/", "author": { "name": "Ar-mane", "email": "abderrahmane.arache@gmail.com", diff --git a/src/constants/Constants.ts b/src/constants/Constants.ts index e501592..4b02c32 100644 --- a/src/constants/Constants.ts +++ b/src/constants/Constants.ts @@ -1,4 +1,4 @@ -export const CONFIG_FILE_NAME_IN_WORKSPACE = '.cmrc.json'; +export const CONFIG_FILE_NAME_IN_WORKSPACE = '.cmrc'; export const EXTENSION_ID = 'Ar-mane.component-maker'; export const EXTENSION_NAME = 'Component maker'; export const MC_MAIN_CMD = 'extension.makeComponent'; diff --git a/template/.cmrc.json b/template/.cmrc.json index 83c2435..941a99c 100644 --- a/template/.cmrc.json +++ b/template/.cmrc.json @@ -1,5 +1,5 @@ { - "$schema": "https://component-maker.vercel.app/schema.json", + "$schema": "https://cm.armane.dev/schema.json", "dir": ".cm_templates", "templates": [ { diff --git a/web/src/configurations.md b/web/src/configurations.md index f41173d..7bb1de0 100644 --- a/web/src/configurations.md +++ b/web/src/configurations.md @@ -1,6 +1,6 @@ -# Configuring `.cmrc.json` +# Configuring `.cmrc` -**.cmrc.json** stands for **Component Maker Run Command**. It is automatically generated and should be placed at the root of your workspace. This file acts as the main entry for the extension, containing all the configurations for your templates. +**.cmrc** stands for **Component Maker Run Command**. It is automatically generated and should be placed at the root of your workspace. This file acts as the main entry for the extension, containing all the configurations for your templates. ### Path Specifications @@ -18,13 +18,13 @@ This distinction ensures that Component Maker can accurately locate your templat ### Purpose and Importance -- **Central Configuration Hub**: `.cmrc.json` serves as the centralized location for managing your template configurations, simplifying the process of customizing and updating your component generation settings. +- **Central Configuration Hub**: `.cmrc` serves as the centralized location for managing your template configurations, simplifying the process of customizing and updating your component generation settings. - **Flexibility and Customization**: This configuration file allows for the definition of various templates that cater to different needs within your project, ensuring that the generated components adhere to your project's structure and coding guidelines. ## Configuration Structure -The `.cmrc.json` file typically includes the following key elements: +The `.cmrc` file typically includes the following key elements: #### `Config` @@ -70,7 +70,7 @@ The `.cmrc.json` file typically includes the following key elements: Below is a configuration example for generating two **react/Next js** components using templates: ```json { - "$schema": "https://component-maker.vercel.app/schema.json", + "$schema": "https://cm.armane.dev/schema.json", "dir": ".cm_templates", "templates": [ { @@ -97,7 +97,7 @@ To add a new template, you'll want to first create a template directory within ` 1. **Create a New Directory**: Inside `.cm_templates`, create a new directory named `service`. 2. **Add Template Files**: Within the `service` directory, add your template files. For instance, you might have `serviceName.service.ts` for defining the service structure. -Here’s how you can update your `.cmrc.json` to include this new template: +Here’s how you can update your `.cmrc` to include this new template: ```json { diff --git a/web/src/usage.md b/web/src/usage.md index 6e233c2..004058e 100644 --- a/web/src/usage.md +++ b/web/src/usage.md @@ -24,7 +24,7 @@ Component Maker integrates seamlessly into your VS Code environment, offering an ![](/images/template.png) -6. **Auto generation config**: For first-time users without an existing configuration in their workspace, a dialog will pop up at the bottom, asking for permission to automatically set up the workspace. This auto-setup process includes creating a template folder and generating a .cmrc.json configuration file. +6. **Auto generation config**: For first-time users without an existing configuration in their workspace, a dialog will pop up at the bottom, asking for permission to automatically set up the workspace. This auto-setup process includes creating a template folder and generating a `.cmrc` configuration file. ![](/images/no_template.png)