Skip to content

Commit

Permalink
Merge pull request #29 from Ar-mane/v.2.0.43
Browse files Browse the repository at this point in the history
fix: rename .json extension from config file
  • Loading branch information
Ar-mane committed Jun 2, 2024
2 parents 10ad313 + 7c1b25c commit f6e1d2f
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<p align="center">
<a href="https://component-maker.vercel.app" target="_blank" rel="noopener noreferrer">
<img src="https://img.shields.io/badge/Read%20the-Docs-42b983.svg?style=for-the-badge&logo=vercel" alt="Read the Docs">
<a href="https://cm.armane.dev" target="_blank" rel="noopener noreferrer">
<img src="https://img.shields.io/badge/Read%20the-Docs-42b983.svg?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgMzIgMzIiCiAgICBzaGFwZS1yZW5kZXJpbmc9Imdlb21ldHJpY1ByZWNpc2lvbiIgdGV4dC1yZW5kZXJpbmc9Imdlb21ldHJpY1ByZWNpc2lvbiI+CiAgICA8dGl0bGU+ZmlsZV90eXBlX2NtcmM8L3RpdGxlPgogICAgPHBhdGgKICAgICAgICBkPSJNMTUuNzU5MDU5LDEuMTczMjM1TDMuMDg3MDY0LDE2LjE0NjY1NEwxNS43NTkwNTksMzEuMTY2NDQ5bDYuNzUyMjYtOC4wNHYtNi40Nzg4NjdsLTYuNzUyMjYsOC41MDk0MTQtNy40MDg0My05LjAxMDM0Mmw3LjQwODQzLTguNzU2MjI0bDQuNzYzNDIyLDUuMjA3MjY0bDIuMzQ3NTExLTMuMDc5ODk4LTcuMTEwOTMzLTguMzQ0NTYxWiIKICAgICAgICB0cmFuc2Zvcm09Im1hdHJpeCgxLjE3NjYgMCAwIDEtMi41NDIxMDktLjE0NjY1NCkiIGZpbGw9IiNmNDUxMWUiIHN0cm9rZS13aWR0aD0iMC4yIiAvPgogICAgPHBhdGgKICAgICAgICBkPSJNOS4yNzE3NjUsMTYuMDQ4ODgybDYuNDQ0MzItNy4zMTEwOTdsNS4wMjU3NDIsNS4xMDA0NWwzLjAxMzA4Mi0zLjc2OTU1OGw1LjM5ODU2NCw1Ljk4MDIwNS01LjM5ODU2NCw2LjAzOTc5NXYtNy43MTY1NDRsLTUuMDE0MTcyLDUuNzE5NTIzLTIuNTk0MDgzLTUuNzE5NTIzLS40MzA1NjksOS4xMjgyOTYtNi40NDQzMi03LjQ1MTU0N1oiCiAgICAgICAgdHJhbnNmb3JtPSJtYXRyaXgoMS4xMTUxODcgMCAwIDEtMS41MjYzNzQtLjA2ODg4MikiIGZpbGw9IiNlMGUwZTAiIHN0cm9rZS13aWR0aD0iMC4yIiAvPgo8L3N2Zz4=" alt="Read the Docs">
</a>
</p>

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": "[email protected]",
Expand Down
2 changes: 1 addition & 1 deletion src/constants/Constants.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
2 changes: 1 addition & 1 deletion template/.cmrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://component-maker.vercel.app/schema.json",
"$schema": "https://cm.armane.dev/schema.json",
"dir": ".cm_templates",
"templates": [
{
Expand Down
12 changes: 6 additions & 6 deletions web/src/configurations.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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`

Expand Down Expand Up @@ -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": [
{
Expand All @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion web/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit f6e1d2f

Please sign in to comment.