Skip to content

Commit

Permalink
Preparing for V2
Browse files Browse the repository at this point in the history
- **Reorganized VSCode Workspace, Improved Readme, Simplified Comments**: Some comments were made simple, The readme file readability was improved, and the VSCode workspace now contain all the new files
  • Loading branch information
burgil committed Oct 20, 2024
1 parent c183984 commit d3a750c
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 22 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Changelog

### Version 1.7.6 - Preparing for V2

- **Reorganized VSCode Workspace, Improved Readme, Simplified Comments**: Some comments were made simple, The readme file readability was improved, and the VSCode workspace now contain all the new files

### Version 1.7.5 - Fixed version not updating in README

- **Deno Bug**: When you run the deno jsr: command it uses a cached version even if many newer versions were launched, to fix it I specify the version inside the installation
Expand Down
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Supe Project Creator v1.7.5
# Supe Project Creator v1.7.6

A simple tool for creating simple web projects with batteries included.

Expand Down Expand Up @@ -80,18 +80,26 @@ By doing so, you will ensure a smooth and successful execution of the scripts.

To start using Supe Project Creator, simply run the following command:

### Create an AI Demo Project in the Current Working Directory:
### Create a Clean Project in the Current Working Directory:

```bash
deno jsr:@supeprojects/[email protected] --demo -n cat-dog-detector -r deno
cd cat-dog-detector
deno jsr:@supeprojects/[email protected] -n my-supe-project --runtime deno
```

### Create a Clean Project in the Current Working Directory:
```bash
deno jsr:@supeprojects/[email protected] -n my-supe-project --runtime deno
cd my-supe-project
```

### Create an AI Demo Project in the Current Working Directory:

```bash
deno jsr:@supeprojects/[email protected] --demo -n cat-dog-detector -r deno
```

```bash
cd cat-dog-detector
```

> [!IMPORTANT]
> Supe Project Creator does not require a separate installation step. Simply execute the command above to create a new project instantly.
Expand Down Expand Up @@ -139,7 +147,7 @@ This behavior is, of course, configurable in `hotreload/config.ts`, allowing you
To view the available options for Supe Project Creator, run the following command:

```bash
deno jsr:@supeprojects/[email protected].5 --help
deno jsr:@supeprojects/[email protected].6 --help
```

- `-h`, `--help`: Displays help information.
Expand Down Expand Up @@ -185,7 +193,7 @@ Utilizing SPC programmatically allows you to:
#### Programmatic Use Example

```ts
import SPC from 'jsr:@supeprojects/[email protected].5';
import SPC from 'jsr:@supeprojects/[email protected].6';

console.log("Testing SPC programmatically...");

Expand Down Expand Up @@ -217,7 +225,7 @@ With these commands, you can easily set up and utilize the Supe Project Creator
To add the `Supe Project Creator` package in Deno, you can import it directly without any installation if you use the `jsr:` prefix in your import:

```ts
import * as SPC from "jsr:@supeprojects/[email protected].5";
import * as SPC from "jsr:@supeprojects/[email protected].6";

// Example usage
console.log("Testing SPC in Deno...");
Expand All @@ -227,7 +235,7 @@ SPC([]); // Shows the help menu
Alternatively, if you prefer to add it, use the following command:

```bash
deno add jsr:@supeprojects/[email protected].5
deno add jsr:@supeprojects/[email protected].6
```

Then, you can import it like this:
Expand Down
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@supeprojects/supe-project-creator",
"version": "1.7.5",
"version": "1.7.6",
"license": "MIT",
"exports": "./index.ts",
"tasks": {
Expand Down
4 changes: 2 additions & 2 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export default function SupeProjectCreator(argv: string[]): void {
// Variables:
let CleanProject = true;
let projectName = '';
const supeVersion = '1.7.5';
const supeVersion = '1.7.6';
const supeVersionDate = '2024-10-16';
let runtime: 'deno' | 'bun' | 'node' | 'none' = 'none';
if (argv.length === 0) argv.push('--help');
Expand Down Expand Up @@ -689,7 +689,7 @@ ${CleanProject ? '' : `
browser: true,
browserDelay: 1550,
address: 'localhost',
secure: false, // Requires SSL Configuration, More Info: ${runtime === 'bun' ? 'bunx http-server --help' : ''}${runtime === 'deno' ? 'deno --allow-sys --allow-env npm:http-server --help' : ''}${runtime === 'node' ? 'npx -y http-server --help' : ''}
secure: false, // Requires SSL Configuration, More Info: http-server --help
hotreload: true,
reconnectDelay: 500,
minify: false,
Expand Down
2 changes: 1 addition & 1 deletion jsr.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@supeprojects/supe-project-creator",
"version": "1.7.5",
"version": "1.7.6",
"exports": "./index.ts",
"license": "MIT"
}
19 changes: 11 additions & 8 deletions supe-project-creator.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@
],
"settings": {
"files.exclude": {
"README.md": false,
"supe-project-creator.code-workspace": false,
// --
"package.json": false,
"bun.lockb": false,
"deno.json": false,
"deno.lock": false,
// --
"jsr.json": false,
// --
"README.md": false,
"ROADMAP.md": true,
"CHANGELOG.md": true,
"CODE_OF_CONDUCT.md": true,
"CONTRIBUTING.md": true,
"LICENSE": true,
// --
"jsr.json": true,
"deno.json": true,
"deno.lock": true,
// --
"*.test.ts": true,
// --
".gitignore": true,
".gitattributes": true,
".github": true,
Expand Down

0 comments on commit d3a750c

Please sign in to comment.