diff options
-rw-r--r-- | .gitlab-ci.yml | 1 | ||||
-rw-r--r-- | .prettierignore | 5 | ||||
-rw-r--r-- | .prettierrc | 5 | ||||
-rw-r--r-- | content/frontend/bundles/404.js | 19 | ||||
-rw-r--r-- | content/frontend/bundles/archives.js | 52 | ||||
-rw-r--r-- | content/frontend/bundles/default.js | 75 | ||||
-rw-r--r-- | content/frontend/bundles/feedback.js | 13 | ||||
-rw-r--r-- | content/frontend/bundles/home.js | 13 | ||||
-rw-r--r-- | content/frontend/components/banner/banner.vue | 4 | ||||
-rw-r--r-- | content/frontend/components/navigation_toggle/navigation_toggle.vue | 4 | ||||
-rw-r--r-- | content/frontend/components/version_banner/version_banner.vue | 5 | ||||
-rw-r--r-- | package.json | 9 | ||||
-rw-r--r-- | rollup.config.js | 8 | ||||
-rw-r--r-- | spec/javascripts/components/banner/banner_spec.js | 4 | ||||
-rw-r--r-- | spec/javascripts/components/navigation_toggle/navigation_toggle_spec.js | 2 | ||||
-rw-r--r-- | yarn.lock | 5 |
16 files changed, 115 insertions, 109 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1655eb0c..38cf0ea1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -139,6 +139,7 @@ js_lint: script: - yarn install --cache-folder .yarn-cache - yarn eslint + - yarn prettier cache: key: files: diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..d4c1002c --- /dev/null +++ b/.prettierignore @@ -0,0 +1,5 @@ +/node_modules/ +/public/ +/vendor/ +/tmp/ +/content/assets/javascripts/ diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..5e2863a1 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,5 @@ +{ + "printWidth": 100, + "singleQuote": true, + "trailingComma": "all" +} diff --git a/content/frontend/bundles/404.js b/content/frontend/bundles/404.js index 6336f4b7..41845bdb 100644 --- a/content/frontend/bundles/404.js +++ b/content/frontend/bundles/404.js @@ -1,12 +1,11 @@ -document.addEventListener( - 'DOMContentLoaded', - () => { - const { environment, offlineVersions, archivesPath } = document.getElementById('offline-versions').dataset; - const location = window.location.href; - const isOffline = offlineVersions.split(',').find(version => location.includes(version)); +document.addEventListener('DOMContentLoaded', () => { + const { environment, offlineVersions, archivesPath } = document.getElementById( + 'offline-versions', + ).dataset; + const location = window.location.href; + const isOffline = offlineVersions.split(',').find(version => location.includes(version)); - if(environment === 'production' && isOffline) { - window.location.replace(archivesPath); - } + if (environment === 'production' && isOffline) { + window.location.replace(archivesPath); } -); +}); diff --git a/content/frontend/bundles/archives.js b/content/frontend/bundles/archives.js index 8b7ac218..4cd0a304 100644 --- a/content/frontend/bundles/archives.js +++ b/content/frontend/bundles/archives.js @@ -1,32 +1,30 @@ import Vue from 'vue'; import Banner from '../components/banner/banner.vue'; -document.addEventListener( - 'DOMContentLoaded', - () => { - const urlParams = window.location.search; - const isOffline = urlParams.includes('?offline'); +document.addEventListener('DOMContentLoaded', () => { + const urlParams = window.location.search; + const isOffline = urlParams.includes('?offline'); - // eslint-disable-next-line no-new - new Vue({ - el: '#js-banner', - components: { - Banner, - }, - render(createElement) { - return createElement(Banner, { - props: { - text: 'You attempted to view an older version of the documentation that is no longer available on this site. Please select a newer version from the menu above or access an archive listed below.', - show: isOffline, + // eslint-disable-next-line no-new + new Vue({ + el: '#js-banner', + components: { + Banner, + }, + render(createElement) { + return createElement(Banner, { + props: { + text: + 'You attempted to view an older version of the documentation that is no longer available on this site. Please select a newer version from the menu above or access an archive listed below.', + show: isOffline, + }, + on: { + toggle(isVisible) { + const wrapper = document.querySelector('.wrapper'); + wrapper.classList.toggle('show-banner', isVisible); }, - on: { - toggle(isVisible) { - const wrapper = document.querySelector('.wrapper'); - wrapper.classList.toggle('show-banner', isVisible); - } - }, - }); - }, - }); - } -); + }, + }); + }, + }); +}); diff --git a/content/frontend/bundles/default.js b/content/frontend/bundles/default.js index a13a18b6..33df43ea 100644 --- a/content/frontend/bundles/default.js +++ b/content/frontend/bundles/default.js @@ -2,45 +2,42 @@ import Vue from 'vue'; import NavigationToggle from '../components/navigation_toggle/navigation_toggle.vue'; import VersionBanner from '../components/version_banner/version_banner.vue'; -document.addEventListener( - 'DOMContentLoaded', - () => { - const versionBanner = document.querySelector('#js-version-banner'); - const isOutdated = versionBanner.hasAttribute('data-is-outdated'); - const { latestVersionUrl, archivesUrl } = versionBanner.dataset; +document.addEventListener('DOMContentLoaded', () => { + const versionBanner = document.querySelector('#js-version-banner'); + const isOutdated = versionBanner.hasAttribute('data-is-outdated'); + const { latestVersionUrl, archivesUrl } = versionBanner.dataset; - // eslint-disable-next-line no-new - new Vue({ - el: versionBanner, - components: { - VersionBanner, - }, - render(createElement) { - return createElement(VersionBanner, { - props: { isOutdated, latestVersionUrl, archivesUrl }, - on: { - toggleVersionBanner(isVisible) { - const wrapper = document.querySelector('.wrapper'); - wrapper.classList.toggle('show-banner', isVisible); - } + // eslint-disable-next-line no-new + new Vue({ + el: versionBanner, + components: { + VersionBanner, + }, + render(createElement) { + return createElement(VersionBanner, { + props: { isOutdated, latestVersionUrl, archivesUrl }, + on: { + toggleVersionBanner(isVisible) { + const wrapper = document.querySelector('.wrapper'); + wrapper.classList.toggle('show-banner', isVisible); }, - }); - }, - }); + }, + }); + }, + }); - // eslint-disable-next-line no-new - new Vue({ - el: '#js-nav-toggle', - components: { - NavigationToggle, - }, - render(createElement) { - return createElement(NavigationToggle, { - props: { - targetSelector: '.nav-wrapper', - } - }); - }, - }); - } -); + // eslint-disable-next-line no-new + new Vue({ + el: '#js-nav-toggle', + components: { + NavigationToggle, + }, + render(createElement) { + return createElement(NavigationToggle, { + props: { + targetSelector: '.nav-wrapper', + }, + }); + }, + }); +}); diff --git a/content/frontend/bundles/feedback.js b/content/frontend/bundles/feedback.js index 7245b90e..628c871e 100644 --- a/content/frontend/bundles/feedback.js +++ b/content/frontend/bundles/feedback.js @@ -1,10 +1,7 @@ -document.addEventListener( - 'DOMContentLoaded', - () => { - const hasCommentAnchor = window.location.hash.includes('#comment-'); +document.addEventListener('DOMContentLoaded', () => { + const hasCommentAnchor = window.location.hash.includes('#comment-'); - if(hasCommentAnchor) { - window.loadDisqus(); - } + if (hasCommentAnchor) { + window.loadDisqus(); } -); +}); diff --git a/content/frontend/bundles/home.js b/content/frontend/bundles/home.js index 286e6c57..40703593 100644 --- a/content/frontend/bundles/home.js +++ b/content/frontend/bundles/home.js @@ -1,8 +1,5 @@ -document.addEventListener( - 'DOMContentLoaded', - () => { - const navBar = document.getElementById('landing-header-bar'); - const navToggle = document.getElementById('docs-nav-toggle'); - navToggle.addEventListener('click', () => navBar.classList.toggle('active')); - } -); +document.addEventListener('DOMContentLoaded', () => { + const navBar = document.getElementById('landing-header-bar'); + const navToggle = document.getElementById('docs-nav-toggle'); + navToggle.addEventListener('click', () => navBar.classList.toggle('active')); +}); diff --git a/content/frontend/components/banner/banner.vue b/content/frontend/components/banner/banner.vue index 530bc9f0..3748bf8e 100644 --- a/content/frontend/components/banner/banner.vue +++ b/content/frontend/components/banner/banner.vue @@ -14,8 +14,8 @@ export default { }, data() { return { - isVisible: this.show - } + isVisible: this.show, + }; }, mounted() { this.toggleBanner(this.isVisible); diff --git a/content/frontend/components/navigation_toggle/navigation_toggle.vue b/content/frontend/components/navigation_toggle/navigation_toggle.vue index 2243dc87..db5ef074 100644 --- a/content/frontend/components/navigation_toggle/navigation_toggle.vue +++ b/content/frontend/components/navigation_toggle/navigation_toggle.vue @@ -10,12 +10,12 @@ export default { toggle() { const target = document.querySelector(this.targetSelector); - if(!target) { + if (!target) { return; } target.classList.toggle('active'); - } + }, }, }; </script> diff --git a/content/frontend/components/version_banner/version_banner.vue b/content/frontend/components/version_banner/version_banner.vue index 66d8fc40..41603419 100644 --- a/content/frontend/components/version_banner/version_banner.vue +++ b/content/frontend/components/version_banner/version_banner.vue @@ -22,13 +22,14 @@ export default { methods: { toggleVersionBanner(isVisible) { this.$emit('toggleVersionBanner', isVisible); - } + }, }, }; </script> <template> <banner :show="isOutdated" @toggle="toggleVersionBanner"> - This is <a :href="archivesUrl">archived documentation</a> for GitLab. Go to <a :href="latestVersionUrl">the latest</a>. + This is <a :href="archivesUrl">archived documentation</a> for GitLab. Go to + <a :href="latestVersionUrl">the latest</a>. </banner> </template> diff --git a/package.json b/package.json index bb048727..5b9f571a 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,9 @@ "scripts": { "bundle": "rollup --config rollup.config.js", "test": "jest", - "eslint": "eslint --max-warnings 0 --ext .js,.vue ." + "eslint": "eslint --max-warnings 0 --ext .js,.vue .", + "prettier": "prettier --check '**/*.{js,vue}'", + "prettier:fix": "prettier --write '**/*.{js,vue}'" }, "devDependencies": { "@babel/core": "^7.6.0", @@ -17,6 +19,7 @@ "eslint": "^6.7.1", "glob": "^7.1.4", "jest": "^24.9.0", + "prettier": "1.19.1", "rollup": "^1.20.3", "rollup-plugin-babel": "^4.3.3", "rollup-plugin-commonjs": "^10.1.0", @@ -26,7 +29,7 @@ "vue-template-compiler": "^2.6.10" }, "dependencies": { - "vue": "^2.6.10", - "@gitlab/svgs": "^1.85.0" + "@gitlab/svgs": "^1.85.0", + "vue": "^2.6.10" } } diff --git a/rollup.config.js b/rollup.config.js index aa03d89e..ed5ee25f 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -8,9 +8,7 @@ function mapDirectory(file) { return file.replace('content/', 'public/'); } -module.exports = glob.sync( - 'content/frontend/bundles/*.js', -).map(file => ({ +module.exports = glob.sync('content/frontend/bundles/*.js').map(file => ({ input: file, output: { file: mapDirectory(file), @@ -23,8 +21,8 @@ module.exports = glob.sync( vue(), importResolver({ alias: { - 'vue': './node_modules/vue/dist/vue.esm.browser.min.js' - } + vue: './node_modules/vue/dist/vue.esm.browser.min.js', + }, }), ], })); diff --git a/spec/javascripts/components/banner/banner_spec.js b/spec/javascripts/components/banner/banner_spec.js index e65cfbe3..5ecc6285 100644 --- a/spec/javascripts/components/banner/banner_spec.js +++ b/spec/javascripts/components/banner/banner_spec.js @@ -7,7 +7,7 @@ describe('component: Banner', () => { let wrapper; beforeEach(() => { - wrapper = mount(Banner, { propsData, }); + wrapper = mount(Banner, { propsData }); }); it('renders a banner', () => { @@ -15,7 +15,7 @@ describe('component: Banner', () => { }); it('renders the correct banner text', () => { - const bannerText = wrapper.find('span'); + const bannerText = wrapper.find('span'); expect(bannerText.text()).toEqual(propsData.text); }); diff --git a/spec/javascripts/components/navigation_toggle/navigation_toggle_spec.js b/spec/javascripts/components/navigation_toggle/navigation_toggle_spec.js index 776969f9..ded96937 100644 --- a/spec/javascripts/components/navigation_toggle/navigation_toggle_spec.js +++ b/spec/javascripts/components/navigation_toggle/navigation_toggle_spec.js @@ -6,7 +6,7 @@ describe('component: Navigation Toggle', () => { beforeEach(() => { const propsData = { targetSelector: '.some-selector' }; - wrapper = mount(NavigationToggle, { propsData, }); + wrapper = mount(NavigationToggle, { propsData }); }); it('renders a toggle button', () => { @@ -4687,6 +4687,11 @@ prettier@1.16.3: resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.16.3.tgz#8c62168453badef702f34b45b6ee899574a6a65d" integrity sha512-kn/GU6SMRYPxUakNXhpP0EedT/KmaPzr0H5lIsDogrykbaxOpOfAFfk5XA7DZrJyMAv1wlMV3CPcZruGXVVUZw== +prettier@1.19.1: + version "1.19.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.19.1.tgz#f7d7f5ff8a9cd872a7be4ca142095956a60797cb" + integrity sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew== + pretty-format@^24.9.0: version "24.9.0" resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-24.9.0.tgz#12fac31b37019a4eea3c11aa9a959eb7628aa7c9" |