Skip to content

Latest commit

 

History

History
184 lines (117 loc) · 6.11 KB

settings.md

File metadata and controls

184 lines (117 loc) · 6.11 KB
Raw

Settings

  • liveServer.settings.port: Customize Port Number of your Live Server. If you want random port number, set it as 0.

    • Default value is 5500.

  • liveServer.settings.root: To change root of server in between workspace folder structure, use / and absolute path from workspace.

    • Example: /sub_folder1/sub_folder2. Now sub_folder2 will be root of the server.

    • Default value is "/".(The Workspace Root).

  • liveServer.settings.CustomBrowser: To change your system's default browser.

    • Default value is null [String, not null]. (It will open your system's default browser.)
    • Available Options :
      • chrome
      • chrome:PrivateMode
      • firefox
      • firefox:PrivateMode
      • microsoft-edge
      • blisk

    Not enough? need more? open an/a issue/pull request on github. For now, use liveServer.settings.AdvanceCustomBrowserCmdLine settings (see below).

  • liveServer.settings.AdvanceCustomBrowserCmdLine: To set your any favorite browser (Eg: Chrome Canary, Firefox Nightly) using advance Command Line. (You can specify full path of your favorite custom browser).

    • This setting will override CustomBrowser and ChromeDebuggingAttachment settings.
    • Default Value is null
    • Examples:
      • chrome --incognito --headless --remote-debugging-port=9222
      • C:\Program Files\Firefox Developer Edition\firefox.exe --private-window

    Note: Either use AdvanceCustomBrowserCmdLine or CustomBrowser. If you use both, AdvanceCustomBrowserCmdLine has higher priority.

  • liveServer.settings.ChromeDebuggingAttachment: To Enable Chrome Debugging Attachment to Live Server. [Quick Gif Demo].

    • NOTE: You must have to install Debugger for Chrome.

    • If the value is true, Start Live Server and select 'Attach to Chrome' from Debug Window to start debugging. Debugger for Chrome Extension will inject debugging feature into running instance of browser window.

    • Default value is false.

  • liveServer.settings.NoBrowser: If it is true live server will start without browser opened.

    • Default Value is false

  • liveServer.settings.ignoreFiles: To ignore specific file changes.

    • Default value is:
    [
    ".vscode/**",
    "**/*.scss",
    "**/*.sass",
    "**/*.ts"
]

    Now, by default Live Server will not track changes of your .scss & .sass files.

  • liveServer.settings.donotShowInfoMsg: To turn off information pop-up messages like "Server starts with port xxxx" or like that. To turn off it, you can set the value as true or you can click to "Don't show again" when a information message pop-up.

    • Default value is : false

  • liveServer.settings.host: To switch host name between localhost and 127.0.0.1 or anything else.

    • Default is 127.0.0.1.

  • liveServer.settings.additionalTagsForLiveReload: (Experimental Feature - BETA)

    [This Settings is dropped and this feature can be replacemented with Live Server Web Extension]

  • liveServer.settings.donotVerifyTags: To turn off prompt warning message if body or head or other supporting tag is missing in your HTML.

    • Default value if false

  • liveServer.settings.https: To enable https protocol.

    • Properties :
     "liveServer.settings.https": {
    "enable": false, //set it true to enable the feature.
    "cert": "C:\\https\\server.cert", //full path
    "key": "C:\\https\\server.key", //full path
    "passphrase": "12345"
},

  • liveServer.settings.proxy: To enable proxy.

    • Properties :
    /* 
     In easy word, it means you're shifting your real url (actual PHP url) 
     to another url (which LiveSever will start).
*/

 "liveServer.settings.proxy": {
    "enable": false, //set it true to enable the feature.
    "baseUri": "/", //from where you want to proxy. 
    "proxyUri": "http://localhost/php/" //the actual url.
},

  • liveServer.settings.useWebExt: : If it is true, Live Reload will be fully controled by the Live Server Web Extension. And also, it does not matter if your HTML have <body> tag or not, Live Reload will work for every file. 😄

    • Default is false

  • liveServer.settings.fullReload: : By Default Live Server inject CSS changes without full reloading of browser. You can change this behavior by making this setting as true.

    • Default: false

  • liveServer.settings.wait: : Delay before live reloading. Value in milliseconds.

    • Default: 100

  • liveServer.settings.mount: : Mount a directory to a route.

    • Default: []

    • Example:

    {
    "liveServer.settings.mount": [
        ["/", "/path1"],
        ["/", "/path2"],
        ["/root", "/dist"]
    ]
}

  • liveServer.settings.useLocalIp: : Use local IP as host.

    • Default: false

  • liveServer.settings.file: : Path to the entry point file. Useful for SPA

    • Default: ""

  • liveServer.settings.multiRootWorkspaceName: : This the entry point of server when you're in multiroot workspace.

    • Default: null

    • You can change it using Command Palette ctrl+shift+p & type Live Server: Change Live Server workspace

    • Tips: You don't need to set this setting, Live Server is smart enough, it'll eigher ask what you want or automatically set the correct workspace if open the server by right clicking any HTML file.