obadakhalili / sprightly Goto Github PK

Read this to understand express's template engine invocation logic.

The package should provide a .__express API that maps to invoking the sprightly engine with the default parameters. Also, there should be another API for users to pass options for the engine.

The first API is invoked directly by express and the user doesn't have to know about it. The second one the user sets it up using the syntax:

app.engine("html", <call to a function that returns the sprightly engine function loaded with the passed options>);

Write the documentation in the README.md file.

New engine's requirements are described in #2

i newly to this template look fun but seems need docs to render dynamic pages,

Make sure that the rewrite achieves the following:

• The engine should be written in TS.
• Follow a functional approach to implement the engine, as opposed to the OOP one implemented currently.
• Use JS's new method .replaceAll() to implement the transformation logic.
• Currently, if you have the views directory set to ./views and the dir is laid out as follows:

./views
+- file.spy
+- subfolder
+---- nested-file.spy

If subfolder/nested-file.spy wanted to include file.spy as a partial, it would have to reference it as follows ./file.spy instead of ../file.spy (since it's one level up in the tree) because the files are resolved relative to the pre-set ./views directory. You need to fix this behavior and implement the correct one mentioned first.

• Implement a good error tracing strategy.
• Implement a caching strategy.
• Support escaping syntax.
• The API should take the form:

function sprightly(
  entryPoint: string,
  data: Record<string, string>,
  options: { cache: boolean }
): Promise<string> {
  ...
}

• Support accessing nested properties. Example:
  Given

<h1>{{ nested.property }}</h1>

and

const data = {
  nested: {
    property: "Osid's awesome"
  }
}

should resolve in:

<h1>Osid's awesome</h1>

• Support express through the .__express property. Read more here and here.