film-watch-options

Under construction

Web component that provides different representations to watch a film. The representation is based on the

• the tag content - the film's name e.g. <film-watch-options jsonurl="">The String</film-watch-options>
• and a JSON file (located at jsonurl) that specifies if and how the film is available.

Still very much a work in progress.

The dev/index.html file gives some examples (including broken examples)

How it works

A data source is specified (e.g. a JSON file's URL). The data source is essentially a hash from film name to a URL online where the film can be found. The component uses a singleton to retrieve and cache the data source.

On render, the component translates the film name provided in the web component into an embedded video player. The component currently works for (fairly limited, specific) video URLs from

• Web Archive (archive.org)
• DailyMotion (dailymotion.com)
• Microsoft stream (microsoftstream.com)
• Vimeo (vimeo.com)
• YouTube (youtube.com)

To do

• Be more flexible in how video URLs are handled
• Support other means of specifying the data source (CSV?)
• Generally tidy everything up

Name recognition

• be case insensitive?

Views

• have attributes to specify different types of views (e.g. small, just a link)

Setup

Install dependencies:

npm i

Testing

This sample modern-web.dev's @web/test-runner along with Mocha, Chai, and some related helpers for testing. See the modern-web.dev testing documentation for more information.

Tests can be run with the test script:

npm test

Dev Server

This sample uses modern-web.dev's @web/dev-server for previewing the project without additional build steps. Web Dev Server handles resolving Node-style "bare" import specifiers, which aren't supported in browsers. It also automatically transpiles JavaScript and adds polyfills to support older browsers. See modern-web.dev's Web Dev Server documentation for more information.

To run the dev server and open the project in a new browser tab:

npm run serve

There is a development HTML file located at /dev/index.html that you can view at http://localhost:8000/dev/index.html.

Editing

If you use VS Code, we highly reccomend the lit-plugin extension, which enables some extremely useful features for lit-html templates:

• Syntax highlighting
• Type-checking
• Code completion
• Hover-over docs
• Jump to definition
• Linting
• Quick Fixes

The project is setup to reccomend lit-plugin to VS Code users if they don't already have it installed.

Linting

Linting of JavaScript files is provided by ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.

The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json.

To lint the project run:

npm run lint

Formatting

Prettier is used for code formatting. It has been pre-configured according to the Polymer Project's style. You can change this in .prettierrc.json.

Prettier has not been configured to run when commiting files, but this can be added with Husky and and pretty-quick. See the prettier.io site for instructions.

Static Site

This project includes a simple website generated with the eleventy static site generator and the templates and pages in /docs-src. The site is generated to /docs and intended to be checked in so that GitHub pages can serve the site from /docs on the master branch.

To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".

To build the site, run:

npm run docs

To serve the site locally, run:

npm run docs:serve

To watch the site files, and re-build automatically, run:

npm run docs:watch

The site will usually be served at http://localhost:8000.

Bundling and minification

This starter project doesn't include any build-time optimizations like bundling or minification. We recommend publishing components as unoptimized JavaScript modules, and performing build-time optimizations at the application level. This gives build tools the best chance to deduplicate code, remove dead code, and so on.

For information on building application projects that include LitElement components, see Build for production on the LitElement site.

More information

See Get started on the LitElement site for more information.