mirror of https://github.com/openwrt/luci.git
4900913d2a
bump checkout to 6 Included is a selection of rules which flag common problems. Lint -JS ( ESlint ) -JSON ( https://github.com/eslint/json ) -JSDoc (comment matter) in the luci-base module -Markdown ( https://github.com/eslint/markdown ) For JSON, mandate standard JSON (not JSONC or JSON5) format, **/*.json checks across the whole repo. For JS, mandate sourceType: 'script', otherwise the linter errors out about return methods in modules which masks other problems. There are a number of structural design changes needed to bring this repo into compliance with standards. Each JS file is an individual script, despite their module like structure, so functions and classes offloaded to 'common' files (individual scripts and not modules) are invisible to linters unless we define them under the 'globals' key. Custom rules and parsers are also possible. For JSDoc, mandate some common checks to ensure the repo will generate consistent documentation which links and displays well. For MD, check also JS syntax inside MD, as well as MD itself. JS checks inside MD are not strict. Included also eslint-formatter-gha (-f gha) which comments on PRs when problems are detected in code additions. Actions show green when no errors are reported (warnings are a pass) but the gha will comment about warnings. Flag `--diff-filter=ACM` shows only additions, and not deletions. Signed-off-by: Paul Donald <newtwen+github@gmail.com> |
||
|---|---|---|
| .github | ||
| applications | ||
| build | ||
| collections | ||
| contrib/package | ||
| doc_gen | ||
| docs | ||
| libs | ||
| modules | ||
| protocols | ||
| themes | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| NOTICE | ||
| README.md | ||
| eslint.config.mjs | ||
| jsdoc.conf.json | ||
| luci.mk | ||
| package.json | ||
README.md
OpenWrt luci feed
Description
This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.
Usage
This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:
src-git luci https://github.com/openwrt/luci.git
To install all its package definitions, run:
./scripts/feeds update luci
./scripts/feeds install -a -p luci
API Reference
You can browse the generated API documentation directly on Github.
Use ucode and rpcd for server side operations.
Development
Documentation for developing and extending LuCI can be found in the Wiki
License
See LICENSE file.
Package Guidelines
See CONTRIBUTING.md file.
Translation status
Use Weblate instead of direct editing of the *.po files.
