A Simple-To-Use Dynamic File Content Manager For Webservers. 

A Simple-To-Use Dynamic File Content Manager For Webservers

kartikk221

live-directory

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

    "description": "A Simple-To-Use Dynamic File Content Manager For Webservers",

        "test": "echo \"Error: no test specified\" && exit 1"

    "homepage": "https://github.com/kartikk221/live-directory",

        "url": "git+ssh://git@github.com:kartikk221/live-directory.git"

        "url": "https://github.com/kartikk221/live-directory/issues"

# LiveDirectory: Dynamic File Content Manager

[![NPM version](https://img.shields.io/npm/v/live-directory.svg?style=flat)](https://www.npmjs.com/package/live-directory)

[![NPM downloads](https://img.shields.io/npm/dm/live-directory.svg?style=flat)](https://www.npmjs.com/package/live-directory)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/kartikk221/live-directory.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/kartikk221/live-directory/context:javascript)

[![GitHub issues](https://img.shields.io/github/issues/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/issues)

[![GitHub stars](https://img.shields.io/github/stars/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/stargazers)

[![GitHub license](https://img.shields.io/github/license/kartikk221/live-directory)](https://github.com/kartikk221/live-directory/blob/master/LICENSE)

Implementing your own template/file management system which consistently reads/updates file content can be tedious. LiveDirectory aims to solve that by acting as an automated file content store making a directory truly come alive. Powered by the efficient file watching library chokidar, LiveDirectory can be an efficient solution for fast and iterative web development.

LiveDirectory can be installed using node package manager (`npm`)

- [LiveDirectory: Dynamic File Content Manager](#livedirectory-dynamic-file-content-manager)

  - [Table Of Contents](#table-of-contents)

      - [Serving a basic HTML page](#serving-a-basic-html-page)

      - [Customized Dashboard User Page With Compiled Renderer](#customized-dashboard-user-page-with-compiled-renderer)

      - [Constructor Options](#constructor-options)

      - [LiveDirectory Properties](#livedirectory-properties)

      - [LiveDirectory Methods](#livedirectory-methods)

      - [LiveFile Properties](#livefile-properties)

      - [LiveFile Methods](#livefile-methods)

Below are varios examples that make use of most classes and methods in LiveDirectory. The [`micromustache`](https://www.npmjs.com/package/micromustache) template renderer is used in the examples below but you can use any other renderer/framework.

const LiveDirectory = require('live-directory');

const live_templates = new LiveDirectory({

// Create server route for dashboard user page

some_server.get('/dashboard/user', (request, response) => {

    // Some processing done here which generates some user_options for rendering page uniquely

    // Retrieve template LiveFile instance

    // Below relative path is translated under the hood to './templates/html/dashboard/user.html'

    let template = live_templates.get('/dashboard/user.html');

    // Send rendered html code in response

    return response.send(template.content);

#### Customized Dashboard User Page With Compiled Renderer

const MicroMustache = require('micromustache');

// Handle 'reload' event from LiveDirectory so we can re-generate a new compiled micromustache instance on each file content update

live_templates.on('file_reload', (file) => {

    // We can attach our own properties to the LiveFile object

    // Using this, we can recompile a micromustache renderer and attach onto LiveFile

    const compiled = MicroMustache.compile(file.content);

    compiled_templates[file.path].render = compiled.render;

| `path` | `String` | System file path. |

| `extension` | `String` | File extension. |

| `etag` | `String` | Unique etag compatible file hash. |

| `content` | `String` | File text content. |

| `buffer` | `Buffer` | File raw content. |

| `last_update` | `Number` | Last file text content update timestamp in **milliseconds** |

* `ready()`: Returns a `Promise` which is resolved once file is ready with initial content.

* `reload()`: Returns a `Promise` which is resolved once the File's content is reloaded.

const DirectoryTree = require('./DirectoryTree.js');

const LiveFile = require('./LiveFile.js');

class LiveDirectory extends EventEmitter {

     * @param {String} options.path Path of the desired directory

     * @param {Object} options.keep Keep/Whitelist filter.

     * @param {Array} options.keep.names List of files/directories to keep/whitelist.

     * @param {Array} options.keep.extensions List of file extensions to keep/whitelist.

     * @param {Object} options.ignore Ignore/Blacklist filter

     * @param {Array} options.ignore.names List of files/directories to ignore/blacklist.

     * @param {Array} options.ignore.extensions List of file extensions to ignore/blacklist.

        // Enforce object only options type

        if (options == null || typeof options !== 'object')

            throw new Error('LiveDirectory options must be an object.');

        // Resolve user provided path to absolute path and wrap local options object

        options.path = resolve_path(options.path);

        wrap_object(this.#options, options);

        // Parse user provided filters into methods

        // Create a empty directory tree for root path

        this.#tree = new DirectoryTree();

     * Parses user provided keep filters into a application method for fast checking.

            // If user provided a function, we simply passthrough that function to the apply method

            if (typeof keep == 'function') {

                this.#filters.keep = keep;

            } else if (typeof keep == 'object') {

                // Destructure and store the keep filters into key

                const { names, extensions } = this.#options.keep;

                const verify_names = Array.isArray(names) && names.length > 0;

                const verify_extensions = Array.isArray(extensions) && extensions.length > 0;

                // Create and bind an apply filter for enforcing key comparisons

                if (verify_names || verify_extensions)

                    this.#filters.keep = (path, stats) => {

                        // Only apply keep filters on files as full tree traversal is neccessary to retrieve all files

                        if (stats == undefined || stats.isDirectory()) return true;

                        // Apply names whitelist if a names array is provided

                        if (verify_names) {

                            let verdict = false;

                            for (let i = 0; i < names.length; i++) {

                                let current = names[i];

                                if (path.endsWith(current)) {

                                    verdict = true;

                                    break;

                            // Return false for keeping if matching against names fails

                            if (!verdict) return false;

                reference.#ready_resolve();

		{
		"name": "live-directory",
		"version": "2.2.0",
		"version": "2.3.0",
		"description": "A Simple-To-Use Dynamic File Content Manager For Webservers",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -173,2 +173,3 @@ # LiveDirectory: Dynamic File Content Manager
		\| `path` \| `String` \| System file path. \|
		\| `name` \| `String` \| File name. \|
		\| `extension` \| `String` \| File extension. \|
		@@ -175,0 +176,0 @@ \| `etag` \| `String` \| Unique etag compatible file hash. \|

		@@ -323,5 +323,7 @@ const EventEmitter = require('events');
		reference.#ready_resolve();
		reference.#ready_promise = true;
		reference.#ready_resolve = null;
		}

		// Mark instance as ready
		reference.#ready_promise = true;
		});
		@@ -328,0 +330,0 @@ }

		@@ -6,2 +6,3 @@ const etag = require('etag');
		class LiveFile {
		#name;
		#etag;
		@@ -24,2 +25,6 @@ #extension;

		// Determine the name of the file
		const chunks = options.path.split('/');
		this.#name = chunks[chunks.length - 1];

		// Determine the extension of the file
		@@ -99,2 +104,3 @@ this.#extension = this.#options.path.split('.');
		}
		this.#ready_promise = true;
		}
		@@ -119,2 +125,6 @@
		/* LiveFile Getters */
		get name() {
		return this.#name;
		}

		get path() {
		@@ -121,0 +131,0 @@ return this.#options.path;

Improved metrics