npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rune-ts/server

v1.0.23

Published

Rune is a modern web development tooling for the modern web developer. It's a zero-config build tool that allows you to build modern web applications with ease.

Downloads

656

Readme

GETTING STARTED

Install

pnpm add -D @types/express @types/express-serve-static-core
pnpm add @rune-ts/server @swc/core

npm install -D @types/express @types/express-serve-static-core
npm install @swc/core @rune-ts/server

pnpm add @rune-ts/server --global
npm install @rune-ts/server --global
  • If you install this into global store, you can execute rune directly.

Usage

rune cli

{
  "dev": "pnpm rune dev",
  "build": "pnpm rune build",
  "start": "pnpm rune start -c rune.prod.config.js"
}
  • All commands support -h and --help flag, allowing you to access the help description.

rune.config.js Setting Example

  • Check the detailed properties in import('@rune-ts/server').RuneConfigType
/**
 * @type {import('@rune-ts/server').RuneConfigType}
 */
module.exports = {
  port: 4000,
  hostname: 'localhost',
  mode: 'render',
  watchToReloadPaths: ['../../../packages'],
  clientEntry: './src/app/client/index.ts',
  serverEntry: './src/app/server/index.ts',
  sassOptions: {
    includePaths: [path.join(__dirname, 'src/app/client')],
    additionalData: `@import "base";`,
  },
  showBundleAnalyzer: false,
  internalModules: [/@packages\/*\w+/, '@marpple/rune-ui'],
};

server method description

import { app } from '@rune-ts/server';

const server = app();
  • After the initial setup for Rune Server Execution. the returned express.Application includes an onEvent method.
server.onEvent('connect', () => {
  console.log('Turn On');
});

server.onEvent('close', () => {
  console.log('Turn Off');
});
  • onEvent method execute a function after trigger event close and connect like above example.
import { createRouter } from '@rune-ts/server';
import { html, Page } from 'rune-ts';

class HelloWorldPage extends Page<{ title: string }> {
  override template({ title }) {
    return html` <div>hello, world: ${title}</div> `;
  }
}

const homeRouter = {
  ['/']: HelloWorldPage,
};

class HelloRunePage extends Page<{ title: string }> {
  override template({ title }) {
    return html` <div>hello, rune: ${title}</div> `;
  }
}

const runeRouter = {
  ['/rune']: HelloRunePage,
};

type Router = typeof homeRouter & typeof runeRouter;

const routers = createRouter<Router>({
  ...homeRouter,
  ...runeRouter,
});

createRouter is a function that makes { key: View(rune-ts) } object
and makes a function which returns instance of View.
then changes function's toString return value to router's key.
and instance of View has key property and value which are a router's key.

import { app } from '@rune-ts/server';
import { MetaView } from '@rune-ts/server';

const server = app();

server.get(routers['/'].toString(), function (req, res) {
  const layoutData: LayoutData = {
    head: {
      title: 'HOME',
      description: 'sss',
    },
  };
  res.send(new MetaView(routers['/']({ name: '', price: 100 }), layoutData).toHtml());
});
  • it is an example of createRouter and MetaView.
  • MetaView is View for SSR.
  • it has many options. please check the type for those options.

client method description

import { hydrate } from '@rune-ts/server';

import { routers } from '../router';

hydrate(routers);
  • if you are using server-side rendering with MetaView or the toHtmlSRR() function of Page,
  • you can hydrate by hydration function.