New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@idio/frontend

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@idio/frontend

The Middleware To Serve Front-End JavaScript.

  • 1.4.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
66
decreased by-12%
Maintainers
1
Weekly downloads
 
Created
Source

@idio/frontend

npm version

@idio/frontend is The Middleware To Serve Front-End JavaScript. It allows to set-up the modern front-end development environment where node_modules are served alongside compiled JSX code (without using Babel, see @a-la/jsx).

yarn add -E @idio/frontend

Table Of Contents

API

The package is available by importing its default function:

import frontend from '@idio/frontend'

async frontend(
  config: FrontendConfig,
): Middleware

The middleware constructor will initialise the middleware function to serve files from the specified directory (frontend by default). The files will be updated on-the-fly to fix their imports to relative paths (e.g., preact will be transformed into /node_modules/preact/dist/preact.mjs). Any CSS styles will also be served using an injector script.

FrontendConfig: Options for the middleware.

NameTypeDescriptionDefault
directorystringThe directory from which to serve files.frontend
pragmastringThe pragma function to import. This enables to skip writing h at the beginning of each file. JSX will be transpiled to have h pragma, therefore to use React it's possible to do import { createElement: h } from 'react'.import { h } from 'preact'

The middleware can be used in any Koa application, or within the idio web server.

/* yarn example/ */
import core from '@idio/core'
import render from 'preact-render-to-string'
import frontend from '@idio/frontend'

(async () => {
  const { url, router, app } = await core({
    logger: { use: true },
    _frontend: {
      use: true,
      middlewareConstructor(_, config) {
        return frontend(config)
      },
      config: {
        directory: 'example/frontend',
      },
    },
  })
  router.get('/', async (ctx) => {
    ctx.body = '<!doctype html>\n' + render(
      <html>
        <head><title>Example</title></head>
        <body>
          Hello World
          <script type="module" src="example/frontend"/>
        </body>
      </html>)
  })
  app.use(router.routes())
  console.log('Started on %s', url)
})()
example/frontend
├── Component.jsx
├── index.jsx
└── style.css

The entry point

import { render } from 'preact'
import Component from './Component'
// linked node_modules are also resolved
import { Form, Input } from '@depack/form'

render(<Component test="Welcome"/>, document.body)
render(<Form>
  <Input placeholder="hello world"/>
</Form>, document.body)

The component

import './style.css'

const Component = ({ test }) => {
  return <div>{test}</div>
}

export default Component

The style

body {
  background: lightcyan;
}

Chrome Example

Art Deco © Art Deco for Idio 2019 Idio Tech Nation Visa Tech Nation Visa Sucks

Keywords

FAQs

Package last updated on 09 Feb 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc