app/sajt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use typescript for the project

Browse source
This commit is contained in:
Artur Gurgul 2025-02-24 18:46:31 +01:00
parent 0f1d41a991
commit 83fd79f674
24 changed files with 2882 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.npmignore
View file

@ -0,0 +1,3 @@
node_modules
src
tsconfig.json

2
bin/sajt
View file

@ -1,3 +1,3 @@
#!/usr/bin/env node
import "../index.js"
import "../dist/index.js"

2637
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

14
package.json
View file

@ -3,10 +3,13 @@
"version": "0.0.2",
"type": "module",
"description": "Static site generator based on pug/html and yaml files",
"main": "index.js",
"main": "dist/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "electron ./src/desktop/main.js"
"start": "electron ./src/desktop/main.js",
"watch": "tsc --watch",
"build": "tsc",
"prepublishOnly": "npm run build"
},
"bin": {
"sajt": "./bin/sajt"
@ -44,6 +47,11 @@
"ssh2-sftp-client": "^11.0.0"
},
"devDependencies": {
"electron": "^33.0.1"
"@types/express": "^5.0.0",
"@types/js-yaml": "^4.0.9",
"@types/node": "^22.13.5",
"@types/pug": "^2.0.10",
"electron": "^33.0.1",
"typescript": "^5.7.3"
}
}

15
src/desktop/index.html
View file

@ -1,15 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
<title>Hello World!</title>
</head>
<body>
<h1>Hello World!</h1>
We are using Node.js <span id="node-version"></span>,
Chromium <span id="chrome-version"></span>,
and Electron <span id="electron-version"></span>.
</body>
</html>

34
src/desktop/main.js
View file

@ -1,34 +0,0 @@
import { app, BrowserWindow } from 'electron'
// import pkg from 'electron';
// console.log("package ", pkg)
// const { app, BrowserWindow } = pkg;
const createWindow = () => {
const win = new BrowserWindow({
width: 800,
height: 600
})
//win.loadFile('index.html')
win.loadFile('/Users/agurgul/projs/home/docs/artur.gurgul.pro/.build/index.html')
}
app.whenReady().then(() => {
createWindow()
app.on('activate', () => {
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit()
})
// REPL
// { app } = await import('electron')
export function run() {
console.log("running")
}

2
index.js → src/index.ts
View file

@ -1,6 +1,6 @@
import { Command } from 'commander'
import chalk from 'chalk'
import fs from 'fs-extra'
//import fs from 'fs-extra'
import path from 'path'
import { newProject, buildProject, appProject } from './project.js'
import { serve } from './serve.js'

4
markdown.js → src/markdown.ts
View file

@ -13,7 +13,7 @@ marked.use(markedHighlight({
}
}))
export function parseMD(file) {
export function parseMD(file: string) {
const fileContents = fs.readFileSync(path.join("./", file), 'utf8')
@ -33,7 +33,7 @@ renderer.paragraph = (text) => {
}
export function parseMarkdown(obj) {
export function parseMarkdown(obj: any) {
for (let key in obj) {
if (typeof obj[key] === 'object' && obj[key] !== null) {
if (Array.isArray(obj[key])) {

8
project.js → src/project.ts
View file

@ -29,7 +29,7 @@ export function buildProject() {
}
config.remote.port = 22
config.remote.privateKey = fs.readFileSync(path.resolve(process.env.HOME, '.ssh/id_rsa'))
config.remote.privateKey = fs.readFileSync(path.resolve(process.env.HOME ?? "", '.ssh/id_rsa'))
build(config)
@ -50,10 +50,10 @@ export function appProject() {
//run()
//const child = proc.spawn(electron, ["."])
console.log(electron)
console.log(electron.default)
// console.log(electron)
// console.log(electron.default)
const child = proc.spawn(electron.default, [".build"])
// const child = proc.spawn(electron.default, [".build"])
// https://www.matthewslipper.com/2019/09/22/everything-you-wanted-electron-child-process.html
// exec('node start', (error, stdout, stderr) => {

8
serve.js → src/serve.ts
View file

@ -1,11 +1,17 @@
import express from 'express'
import { setWatcher } from './watch.js'
const app = express()
const PORT = process.env.PORT || 3000
export function serve() {
app.use(express.static('./.build'))
setWatcher(url => {
console.log(url)
})
app.listen(PORT, () => {
console.log(`Server is running on http://localhost:${PORT}`)
console.log(`Server is running on http://localhost:${PORT}`)
})
}

55
site.js → src/site.ts
View file

@ -1,26 +1,30 @@
import fs from 'fs'
import pug from 'pug'
import path from 'path'
import yaml from 'js-yaml'
function removeDirectorySync(directory) {
import { cp } from "./utils.js"
import { parseMarkdown } from './markdown.js'
import { getAllFilesWithExtension, pathToArray, parseYML } from './utils.js'
import { parseMD } from './markdown.js'
function removeDirectorySync(directory: string) {
try {
fs.rmSync(directory, { recursive: true, force: true })
console.log("Directory and its contents removed.")
} catch (err) {
} catch (err: any) {
console.error(`Error removing directory: ${err.message}`)
}
}
import yaml from 'js-yaml'
export function readConfig() {
export function readConfig(): any {
const __dirname = process.cwd()
const configPath = path.join(__dirname, '.sajt/config.yaml')
const fileContents = fs.readFileSync(configPath, 'utf8')
return yaml.load(fileContents)
}
function compile(template, content, output) {
function compile(template: string, content: any, output: string) {
if (template == null) {
console.error("Template is not defined")
return
@ -41,43 +45,43 @@ function compile(template, content, output) {
console.log(`HTML has been rendered and saved to ${output}`);
}
function compileData(template, content, output) {
const compiledFunction = pug.compileFile(`.sajt/layouts/${template}.pug`);
function compileData(template: string, content: object, output: string) {
const compiledFunction = pug.compileFile(`.sajt/layouts/${template}.pug`)
const dirname = path.dirname(output)
if (!fs.existsSync(dirname)) {
fs.mkdirSync(dirname, { recursive: true })
}
const html = compiledFunction(content)
fs.writeFileSync(output, html)
console.log(`HTML has been rendered and saved to ${output}`);
}
import { getAllFilesWithExtension, pathToArray, parseYML } from './utils.js'
import { parseMD } from './markdown.js'
function readMetadata(ignore) {
function readMetadata(ignore: string[]) {
let htmlExtension = "html"
let list = getAllFilesWithExtension('.',".md", ignore)
let listMD = getAllFilesWithExtension('.',".md", ignore)
.map(f => { return {
pathMD: f,
type: "md",
data: {},
data: {} as any,
md: parseMD(f)
}})
} as any })
// sites needs to include data from header
list = list.concat(
getAllFilesWithExtension('.',".yml", ignore)
.map(f => { return {
pathMD: f,
type: "yml",
data: parseYML(f),
md: {meta: {}}
}})
)
let listYML = getAllFilesWithExtension('.',".yml", ignore)
.map(f => { return {
pathMD: f,
type: "yml",
data: parseYML(f),
md: {meta: {}}
} as any })
let list = listMD.concat(listYML)
for(const site of list) {
@ -111,10 +115,9 @@ function readMetadata(ignore) {
return list
}
import { cp } from "./utils.js"
import { parseMarkdown } from './markdown.js'
export function build(config) {
export function build(config: any) {
removeDirectorySync(config.buildDir)
cp("./.sajt/static", path.join(config.buildDir, "static"))

5
ssh.js → src/ssh.ts
View file

@ -1,4 +1,4 @@
const Client = require('ssh2-sftp-client')
/*const Client = require('ssh2-sftp-client')
async function uploadDirectory(serverConfig, localDirPath) {
const sftp = new Client()
@ -32,4 +32,5 @@ async function upload(sftp, config, localPath, remotePath) {
console.log(`File transferred successfully: ${localFilePath}`)
}
}
}
}
*/

12
utils.js → src/utils.ts
View file

@ -2,14 +2,14 @@ import yaml from 'js-yaml'
import fs from 'fs'
import path from 'path'
export function parseYML(file) {
export function parseYML(file: string) {
const fileContents = fs.readFileSync(file, 'utf8')
return yaml.load(fileContents)
}
export function getAllFilesWithExtension(directory, extension, excludes) {
let results = []
function readDirectory(directory) {
export function getAllFilesWithExtension(directory: string, extension: string, excludes: string[]): string[] {
let results: string[] = []
function readDirectory(directory: string) {
const items = fs.readdirSync(directory)
items.forEach(item => {
@ -30,7 +30,7 @@ export function getAllFilesWithExtension(directory, extension, excludes) {
}
// copyDirectory
export function cp(source, destination) {
export function cp(source: string, destination: string) {
fs.mkdirSync(destination, { recursive: true })
const items = fs.readdirSync(source)
items.forEach(item => {
@ -45,7 +45,7 @@ export function cp(source, destination) {
})
}
export function pathToArray(filePath) {
export function pathToArray(filePath: string) {
// Normalize the file path to handle different OS path separators
const normalizedPath = path.normalize(filePath)
// Split the path into an array of directories

35
src/watch.ts Normal file
View file

@ -0,0 +1,35 @@
import fs from 'fs'
import path from 'path'
export function setWatcher(callback: (url: string) => void) {
// Directory to watch
const directoryPath = './';
// Ensure the directory exists
if (!fs.existsSync(directoryPath)) {
fs.mkdirSync(directoryPath, { recursive: true });
}
console.log(`Watching for changes in: ${directoryPath}`);
// Watch the directory for changes
fs.watch(directoryPath, (eventType, filename) => {
if (filename) {
const fullPath = path.join(directoryPath, filename);
console.log(`File ${filename} has been ${eventType}`);
// Check if the file was added, changed, or deleted
fs.stat(fullPath, (err, stats) => {
if (err) {
if (err.code === 'ENOENT') {
console.log(`File ${filename} was deleted.`);
} else {
console.error(`Error checking file status: ${err.message}`);
}
} else {
if (stats.isFile()) {
console.log(`File ${filename} exists with size: ${stats.size} bytes`);
}
}
});
} else {
console.log('Filename not provided, but change detected.');
}
});
}

123
tsconfig.json Normal file
View file

@ -0,0 +1,123 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "NodeNext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"outDir": "dist",
"rootDir": "src",
"moduleResolution": "NodeNext",
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
"declaration": true,
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
"declarationDir": "types",
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src"],
"exclude": ["node_modules", "dist"]
}

1
types/index.d.ts vendored Normal file
View file

@ -0,0 +1 @@
export {};

7
types/markdown.d.ts vendored Normal file
View file

@ -0,0 +1,7 @@
export declare function parseMD(file: string): {
meta: {
[key: string]: any;
};
content: string | Promise<string>;
};
export declare function parseMarkdown(obj: any): void;

3
types/project.d.ts vendored Normal file
View file

@ -0,0 +1,3 @@
export declare function newProject(): void;
export declare function buildProject(): void;
export declare function appProject(): void;

1
types/serve.d.ts vendored Normal file
View file

@ -0,0 +1 @@
export declare function serve(): void;

2
types/site.d.ts vendored Normal file
View file

@ -0,0 +1,2 @@
export declare function readConfig(): any;
export declare function build(config: any): void;

1
types/ssh.d.ts vendored Normal file
View file

@ -0,0 +1 @@
export {};

4
types/utils.d.ts vendored Normal file
View file

@ -0,0 +1,4 @@
export declare function parseYML(file: string): unknown;
export declare function getAllFilesWithExtension(directory: string, extension: string, excludes: string[]): string[];
export declare function cp(source: string, destination: string): void;
export declare function pathToArray(filePath: string): string[];

1
types/watch.d.ts vendored Normal file
View file

@ -0,0 +1 @@
export declare function setWatcher(callback: (url: string) => void): void;

20
watch.js
View file

@ -1,20 +0,0 @@
const chokidar = require('chokidar')
const directoryPath = "."
// Initialize watcher
const watcher = chokidar.watch(directoryPath, {
ignored: /(^|[\/\\])\../, // ignore dotfiles
persistent: true
});
// Add event listeners
watcher
.on('add', path => console.log(`File ${path} has been added`))
.on('change', path => console.log(`File ${path} has been changed`))
.on('unlink', path => console.log(`File ${path} has been removed`))
.on('error', error => console.error(`Watcher error: ${error}`));
console.log(`Watching for changes in ${directoryPath}`);