Pacharapol WithayasakpuntandGitHub
5d6729ddd5
by @patarapolw * allow manual init and destroy for use with Nuxt * fix onDestroy-related methods * avoid global scope, and use function scope instead * add createInstance function to window.REMARK42 * 1. allow DOMNode to be put in remark_config 2. check remark_config before try to attach node * move createInstance function outside * update embed.ts * avoid ?. * 📚 Docs: doc on how to make it work with SPAs * 📚 Docs: fix spa.md to be more flexible * ✨ Feat: add REMARK42::ready event * remove nuxt-specific terminologies * tell MutationObserver to disconnect on destroy * update docs/spa.md
Frontend guide
Code Style
- project uses typescript to statically analyze code
- project uses
eslintandstylelintto check frontend code. You can manually run vianpm run lint. - git hooks (via husky) installed automatically on
npm installand check and try to fix code style if possible, otherwise commit will be rejected - if you want IDE integration, you need
eslintandstylelintplugin to be installed.
CSS Styles
- although styles have
scssextension, it is actually pack of post-css plugins, so syntax differs, for example incalcfunction. - now we are migrating to css-modules and this is recomended way to stylization. A file with styles should be named like
component.module.css - old component styles use BEM notation (at least it should):
block__element_modifier. Also there aremixclasses:block_modifier. - new way to naming CSS selectors is camel-case like
blockElemenModifierand useclassnamesto combine it - component base style resides in the component's root directory with name of component converted to kebab-case. For example
ListCommentsstyle is located in./app/components/list-comments/list-component.tsx - any other files should be named also in kebab-case. For example
./app/utils/get-param.ts
Imports
- imports for typescript, javascript files should be without extension:
./index, not./index.ts - if file resides in the same directory or in subdirectory import should be relative:
./types/something - otherwise it should start from
@appnamespace:@app/common/storewhich mapped to/app/common/store.tsin webpack, tsconfig and jest
Testing
- project uses
jestas test harness. - jest check files that match regex
\.test\.(j|t)s(x?)$, i.ecomment.test.tsx,comment.test.js - tests are running on push attempt
- example tests can be found in
./app/store/user/reducers.test.ts,./app/components/auth-panel/auth-panel.test.tsx
How to add new locale
Please see this documentation.
Notes
- Frontend part being bundled on docker env gets placed on
/src/weband is available viahttp://{host}/web. for exampleembed.jsentry point will be available athttp://{host}/web/embed.js