sirinoks / ssgnode Goto Github PK

In .md files replace --- for

In https://github.com/sirinoks/SSGNode/blob/main/index.js#L37-L45 you are walking the entire file tree to delete everything below it. This will work, but you can do it in a single call using rm with the recursive: true option.

Change manual command line arguments handling for yargs. It improves cleanliness and code clarity.

You want to put source code in git, but not files which are generated by that source code. If you're working with C/C++, you would put the .c or .cc files in, but not .o or .a or .exe, etc. Same with node, where we don't usually put dist into the repo.

You can remove it with git rm -fr dist and then add a .gitignore file to tell git not to add things not needed by git:

npx gitignore node

This issue, I will be implementing a new feature that will allow the user to use the config file instead of typing out all of the command arguments.

The config file will be formatted like:

{
  "input": "./site",
  "stylesheet": "https://cdn.jsdelivr.net/npm/water.css@2/out/water.css",
  "lang": "fr"
}

Instead of hardcoding name and version, better to take that info from json that has that info.

Optional -l, --lang, and/or \l flag, which indicates the language to use when generating the lang attribute on the root element. For example, --lang fr would mean that the HTML documents are in French, and would include , while -l pt-BR would mean the text is using Brazilian Portuguese: . By default, use en-CA for Canadian English.

Make sure that the program exits with appropriate error codes in all cases. If there are no errors, exit with 0. Otherwise, exit with a non-zero exit code (e.g., -1).

This feature will allow the user to create a config file and specify the value for all the arguments for this file. After the user can just use a --config or -c and the path to the config file. This is an example of what the JSON file would look like:

{
  "input": "./docs",
  "output": "./web"
}

In a few places you are calling *Sync versions of fs methods, for example: here and here. You only use a callback when you use the async versions of these methods.

In https://raw.githubusercontent.com/sirinoks/SSGNode/main/README.md you have trailing \ characters after many lines. I would avoid this and let the text wrap at different widths, depending on the user's viewport.

Another improvement you could make in this file is to wrap your command examples in 3 backticks instead of using a blockquote:

npm install

vs.

npm install

See https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks

In https://github.com/sirinoks/SSGNode/blob/main/LICENSE#L3 you use a username vs. a real name/email. On a legal document, consider using a real name.

I would like to work to modify the file handling so that it supports both .txt files as well as .md
If the file extension is .txt, process the file exactly the same way it is done now (i.e., no changes)

You have a number of hard-coded file paths and directories (eg., https://github.com/sirinoks/SSGNode/blob/main/index.js#L58). You should migrate away from this, and request these from the user. If they don't provide them, you should exit and give an error message. Your program can't know which files they want to work with, so it's valid to require this.

Alex can change "npm init" to "npm install" because init means initiation and this API is already initiated so init is not necessary.

You can add more options to verifying --h and -help, also -version, --v is possible

In function "finalize" lines 119 and 126 use the same code. I know it can be written better, but I don't know how

Currently, your error handling is throwing an error, which will get "caught" by the user. This will mean the program crashes, and the user gets a cryptic error and stack trace.

A better approach is to provide a useful/actionable error message, so the user can fix things, and then exit the program with an error code:

if(err) {
  console.error('Helpful error message here...');
  process.exit(-1);
}

You have 3 dependencies that aren't being used: https://github.com/sirinoks/SSGNode/blob/main/package.json#L21-L23. They can all be removed, and should.

I think you might have used module to generate your code? If so, you can use a trick with node to run a one-time command without installing the whole thing forever:

npx module

The fs module isn't needed, since fs is built into node. The utils module isn't being used anywhere, so can go.

In https://github.com/sirinoks/SSGNode/blob/main/index.js#L10 you are correctly reading a file as utf-8, so the resulting return value will already be a string. You can remove the extra String() call.