Skip to content

Visual Studio Code extension that provides components completion in the HTML, XHTML and Faces. Based on the official Tag Library definitions.

License

Notifications You must be signed in to change notification settings

primefaces-extensions/faces-intellisense

Repository files navigation

VS Code Intellisense for Jakarta Faces

Version License: MIT Installs Discord Chat

A Visual Studio Code extension that provides component completion in the HTML, XHTML and JSF. Based on the official Taglib definitions.

Taglib supported for

  • Primefaces (8.x, 10.x, 11.x, 12.x, 13.x, 14.x)
  • Primefaces Extensions (10.x, 11.x, 12.x, 13.x, 14.x)
  • OmniFaces (3.x, 4.x)
  • RichFaces (4.5.x)
  • JSF (2.1, 2.2, 2.3)
  • Jakarta Faces (4.0, 5.0)

Features

  • Automatic detection of xmlns (You must include the namespace mandatory).

    • Html Basic -> http://java.sun.com/jsf/html or http://xmlns.jcp.org/jsf/html or jakarta.faces.html
    • Faces Core -> http://java.sun.com/jsf/core or http://xmlns.jcp.org/jsf/core or jakarta.faces.core
    • JSTL Core -> http://xmlns.jcp.org/jsp/jstl/core or jakarta.tags.core
    • Composite Components -> http://java.sun.com/jsf/composite or http://xmlns.jcp.org/jsf/composite or jakarta.faces.composite
    • Facelets Templating -> http://java.sun.com/jsf/facelets or http://xmlns.jcp.org/jsf/facelets or jakarta.faces.facelets
    • PrimeFaces -> http://primefaces.org/ui or primefaces
    • PrimeFaces Extensions -> http://primefaces.org/ui/extensions or primefaces.extensions
    • OmniFaces -> http://omnifaces.org/ui or omnifaces.ui
    • RichFaces -> http://richfaces.org/rich
    • RichFaces A4J -> http://richfaces.org/a4j
  • You can customize the alias name.

        <!DOCTYPE html>
        <html lang="en" xmlns="http://www.w3.org/1999/xhtml" 
                xmlns:h="http://java.sun.com/jsf/html"
                xmlns:f="http://java.sun.com/jsf/core" 
                xmlns:cc="http://java.sun.com/jsf/composite" 
                xmlns:p="http://primefaces.org/ui">
                ......
        <!-- Or  -->	
        <!DOCTYPE html>
        <html lang="en" xmlns="http://www.w3.org/1999/xhtml" 
                xmlns:h="http://java.sun.com/jsf/html"
                xmlns:f="http://java.sun.com/jsf/core" 
                xmlns:composite="http://java.sun.com/jsf/composite" 
                xmlns:pf="http://primefaces.org/ui">
                ......
  • Command to manually re-cache the class definitions used in the autocompletion;

  • User Settings.

Supported Language Modes

  • HTML
  • XHTML
  • JSF
  • XML

Extended Support for Other Language Modes

It's possible to specify which language modes will have autocompletion. There are five settings for this feature:

  • faces-intellisense.languages is for language modes based on HTML.

What's new

Check out the changelog for the current and previous updates.

Usage

The extension will automatically display the completion options. In case the completion is not showing, you can run the command by pressing Ctrl+Shift+P (Cmd+Shift+P for Mac) and then typing "Faces Cache".

More User Settings

The extension supports a few user settings, changes to these settings will be automatically recognized and the caching process will be re-executed.

Generate Tag Libraries

To generate or update tag libraries you can do the following:

  1. Navigate to \generator.
  2. Run npm install
  3. Run npm run start to generate new code.

To add a new library or update just edit \generator\src\index.ts and run npm run start.

Contributions

You can request new features and contribute to the extension development on its repository on GitHub. Look for an issue you're interested in working on, comment on it to let me know you're working on it and submit your pull request! :D

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Per-Steinar Karlsen
Per-Steinar Karlsen

💻
Tito Sanchez
Tito Sanchez

💻
Leonardo SJ
Leonardo SJ

💻
FlipWarthog
FlipWarthog

🚧 💻
Melloware
Melloware

💻
DebasishWe
DebasishWe

📓

This project follows the all-contributors specification. Contributions of any kind welcome!