@alexgamingdev/arch-it 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +32 -0
- package/CODE_OF_CONDUCT.md +15 -0
- package/LICENSE +21 -0
- package/README.md +29 -0
- package/SECURITY.md +14 -0
- package/assets/logo.png +0 -0
- package/bin/index.js +36 -0
- package/blueprint.json +32 -0
- package/package.json +26 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ main ]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [ main ]
|
|
8
|
+
|
|
9
|
+
jobs:
|
|
10
|
+
build:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
|
|
15
|
+
- name: Use Node.js
|
|
16
|
+
uses: actions/setup-node@v4
|
|
17
|
+
with:
|
|
18
|
+
node-version: '20'
|
|
19
|
+
|
|
20
|
+
- name: Install dependencies
|
|
21
|
+
run: npm install
|
|
22
|
+
|
|
23
|
+
- name: Validate Blueprint Structure
|
|
24
|
+
run: |
|
|
25
|
+
if [ -f blueprint.json ]; then
|
|
26
|
+
node -e "const b = require('./blueprint.json'); if(!b.projectName || !b.structure) throw new Error('Missing required fields'); console.log('ā
Blueprint structure is valid');"
|
|
27
|
+
else
|
|
28
|
+
echo "ā ļø No blueprint.json found to validate, skipping."
|
|
29
|
+
fi
|
|
30
|
+
|
|
31
|
+
- name: Run Tests
|
|
32
|
+
run: npm test
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
|
|
5
|
+
|
|
6
|
+
## Our Standards
|
|
7
|
+
Examples of behavior that contributes to a positive environment include:
|
|
8
|
+
* Using welcoming and inclusive language.
|
|
9
|
+
* Being respectful of differing viewpoints and experiences.
|
|
10
|
+
* Gracefully accepting constructive criticism.
|
|
11
|
+
* Focusing on what is best for the community.
|
|
12
|
+
* Showing empathy towards other community members.
|
|
13
|
+
|
|
14
|
+
## Enforcement
|
|
15
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **contact@alexgaming.dev**.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 alexgaming.dev
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Arch-It šļø
|
|
2
|
+
|
|
3
|
+
Professional scaffolding engine by **Alex Gaming Studio**. Turn Blueprints into Projects.
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+
[](https://github.com/AlexGaming-dev/arch-it/blob/main/LICENSE)
|
|
7
|
+
[](https://github.com/AlexGaming-dev/arch-it/actions)
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
Run this command to install the tool globally:
|
|
12
|
+
|
|
13
|
+
````bash
|
|
14
|
+
npm install -g @alexgamingdev/arch-it
|
|
15
|
+
````
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
Create a `blueprint.json` and run:
|
|
19
|
+
````bash
|
|
20
|
+
arch-it
|
|
21
|
+
````
|
|
22
|
+
|
|
23
|
+
## Features
|
|
24
|
+
- Blueprint Driven: Define your structure in JSON.
|
|
25
|
+
- Instant Scaffolding: Generates folders and files automatically.
|
|
26
|
+
- Professional Grade: Maintained by Alex Gaming Studio.
|
|
27
|
+
|
|
28
|
+
## License
|
|
29
|
+
MIT Copyright (c) 2026 alexgaming.dev
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
Currently, the following versions of Arch-It are supported with security updates:
|
|
5
|
+
|
|
6
|
+
| Version | Supported |
|
|
7
|
+
| ------- | ------------------ |
|
|
8
|
+
| 1.0.x | ā
Yes |
|
|
9
|
+
| < 1.0.0 | ā No |
|
|
10
|
+
|
|
11
|
+
## Reporting a Vulnerability
|
|
12
|
+
If you discover a security vulnerability, please **do not** open a public issue. Instead, send an email to **contact@alexgaming.dev**.
|
|
13
|
+
|
|
14
|
+
We will acknowledge your report within 48 hours and provide a timeline for a fix.
|
package/assets/logo.png
ADDED
|
Binary file
|
package/bin/index.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const fs = require('fs-extra');
|
|
4
|
+
const path = require('path');
|
|
5
|
+
const chalk = require('chalk');
|
|
6
|
+
|
|
7
|
+
async function build() {
|
|
8
|
+
const blueprintPath = path.join(process.cwd(), 'blueprint.json');
|
|
9
|
+
|
|
10
|
+
if (!fs.existsSync(blueprintPath)) {
|
|
11
|
+
console.log(chalk.red("ā Error: No blueprint.json found in this directory!"));
|
|
12
|
+
return;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
try {
|
|
16
|
+
const blueprint = await fs.readJson(blueprintPath);
|
|
17
|
+
console.log(chalk.blue.bold(`\nšļø Arch-It: Building "${blueprint.projectName}"...\n`));
|
|
18
|
+
|
|
19
|
+
for (const [folder, files] of Object.entries(blueprint.structure)) {
|
|
20
|
+
const folderPath = path.join(process.cwd(), folder);
|
|
21
|
+
await fs.ensureDir(folderPath);
|
|
22
|
+
console.log(`${chalk.green('DIR')} ${folder}/`);
|
|
23
|
+
|
|
24
|
+
for (const [fileName, content] of Object.entries(files)) {
|
|
25
|
+
await fs.writeFile(path.join(folderPath, fileName), content);
|
|
26
|
+
console.log(`${chalk.cyan('FILE')} āāā ${fileName}`);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
console.log(chalk.magenta.bold("\n⨠Construction complete! Project is ready.\n"));
|
|
31
|
+
} catch (err) {
|
|
32
|
+
console.error(chalk.red("Build failed:"), err);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
build().catch(err => console.error(err));
|
package/blueprint.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"_comment_1": "ARCH-IT BLUEPRINT GUIDE: This file defines your project structure.",
|
|
3
|
+
"_comment_2": "The 'projectName' is the display name during the build process.",
|
|
4
|
+
"projectName": "Arch-It-Documentation-Demo",
|
|
5
|
+
|
|
6
|
+
"structure": {
|
|
7
|
+
".": {
|
|
8
|
+
"_comment_3": "The '.' folder represents your current root directory.",
|
|
9
|
+
"README.md": "# New Project\nCreated with Arch-It.",
|
|
10
|
+
"arch-it-notes.txt": "How to use:\n1. Edit this blueprint.json\n2. Run 'arch-it' in the terminal\n3. Watch the magic happen."
|
|
11
|
+
},
|
|
12
|
+
"src": {
|
|
13
|
+
"_comment_4": "Keys inside 'structure' (like 'src') will be created as folders.",
|
|
14
|
+
"index.js": "// Your main entry file\nconsole.log('App started');",
|
|
15
|
+
"utils.js": "// Add utility functions here"
|
|
16
|
+
},
|
|
17
|
+
"src/internal": {
|
|
18
|
+
"_comment_5": "You can also define nested paths directly as keys.",
|
|
19
|
+
"core.js": "/* Core Logic */"
|
|
20
|
+
},
|
|
21
|
+
"docs": {
|
|
22
|
+
"_comment_6": "Each file within a folder key needs a name and its content string.",
|
|
23
|
+
"setup.md": "# Setup Instructions\nStep 1: Install dependencies."
|
|
24
|
+
},
|
|
25
|
+
"assets": {
|
|
26
|
+
"_comment_7": "Folders will only be created if they contain at least one file.",
|
|
27
|
+
".gitkeep": ""
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
|
|
31
|
+
"_comment_final": "Alex Gaming Studio - Professional Scaffolding Engine"
|
|
32
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@alexgamingdev/arch-it",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Professional scaffolding engine by Alex Gaming Studio. Turn Blueprints into Projects.",
|
|
5
|
+
"main": "bin/index.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"arch-it": "bin/index.js"
|
|
8
|
+
},
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/AlexGaming-dev/arch-it.git"
|
|
12
|
+
},
|
|
13
|
+
"scripts": {
|
|
14
|
+
"test": "node -e \"console.log('Tests passed: Package is executable'); process.exit(0)\""
|
|
15
|
+
},
|
|
16
|
+
"author": "Alex Gaming Studio",
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"dependencies": {
|
|
19
|
+
"fs-extra": "^11.1.0",
|
|
20
|
+
"chalk": "^4.1.2"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/AlexGaming-dev/arch-it/issues"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://alexgaming.is-a.dev/projects/redirect/arch-it/"
|
|
26
|
+
}
|