Merge pull request #12 from atom-minimap/update

Author: UziTech

.eslintrc.js

@@ -0,0 +1,36 @@
+module.exports = {
+	env: {
+		es6: true,
+		browser: true,
+		node: true,
+		jasmine: true,
+		atomtest: true,
+	},
+	extends: [
+		'standard',
+	],
+	globals: {
+		atom: 'readonly',
+	},
+	parserOptions: {
+		ecmaVersion: 2018,
+	},
+	rules: {
+		'no-warning-comments': 'warn',
+		'comma-dangle': ['error', 'always-multiline'],
+		indent: ['error', 'tab', { SwitchCase: 1 }],
+		'no-tabs': ['error', { allowIndentationTabs: true }],
+		'no-restricted-globals': [
+			'error',
+			{
+				name: 'fit',
+				message: 'Do not commit focused tests.',
+			},
+			{
+				name: 'fdescribe',
+				message: 'Do not commit focused tests.',
+			},
+		],
+		'no-sync': 'error',
+	},
+}

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    versioning-strategy: "increase"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/CI.yml

@@ -0,0 +1,74 @@
+name: "CI"
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  CI: true
+
+jobs:
+  Test:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        channel: [stable, beta]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: UziTech/action-setup-atom@v1
+      with:
+        channel: ${{ matrix.channel }}
+    - name: Atom version
+      run: atom -v
+    - name: APM version
+      run: apm -v
+    - name: Install package dependencies
+      run: apm i minimap bookmarks
+    - name: Install dependencies
+      run: apm ci
+    - name: Run tests 👩🏾‍💻
+      run: atom --test spec
+
+  Lint:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/[email protected]
+        with:
+          node-version: '*'
+      - name: NPM install
+        run: npm ci
+      - name: Lint ✨
+        run: npm run lint
+
+  Release:
+    needs: [Test, Lint]
+    if: |
+      github.ref == 'refs/heads/master' &&
+      github.event.repository.fork == false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: UziTech/action-setup-atom@v1
+      - uses: actions/[email protected]
+        with:
+          node-version: '*'
+      - name: NPM install
+        run: npm ci
+      - name: Release 🎉
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ATOM_ACCESS_TOKEN: ${{ secrets.ATOM_ACCESS_TOKEN }}
+        run: npx semantic-release
+
+  Skip:
+    if: contains(github.event.head_commit.message, '[skip ci]')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Skip CI 🚫
+        run: echo skip ci

.travis.yml

@@ -1,4 +1,6 @@
-# minimap-bookmarks package [![Build Status](https://travis-ci.org/atom-minimap/minimap-bookmarks.svg?branch=master)](https://travis-ci.org/atom-minimap/minimap-bookmarks)
+# minimap-bookmarks package
+
+[![Build Status](https://github.com/atom-minimap/minimap-bookmarks/workflows/CI/badge.svg)](https://github.com/atom-minimap/minimap-bookmarks/actions)
 
 Displays Atom bookmarks in the minimap.
 

README.md

@@ -0,0 +1,65 @@
+const { CompositeDisposable } = require('atom')
+
+class MinimapBookmarksBinding {
+	constructor (minimap, bookmarks) {
+		this.minimap = minimap
+		this.bookmarks = bookmarks
+		if ((this.minimap == null) || (this.bookmarks == null)) { return }
+
+		this.subscriptions = new CompositeDisposable()
+		this.editor = this.minimap.getTextEditor()
+		this.decorationsByMarkerId = {}
+		this.decorationSubscriptionsByMarkerId = {}
+
+		// We need to wait until the bookmarks package had created its marker
+		// layer before retrieving its id from the state.
+		requestAnimationFrame(() => {
+			// Also, targeting private properties on atom.packages is very brittle.
+			// DO NOT DO THAT!
+			//
+			// If we really have to get the marker layer id from the
+			// state (which can already break easily) it's better to get it from the
+			// package `serialize` method since it's an API that is public and is
+			// unlikely to change in a near future.
+			const bookmarks = this.bookmarks.serialize()[this.editor.id]
+			if (!bookmarks) { return }
+
+			const markerLayer = this.editor.getMarkerLayer(bookmarks.markerLayerId)
+
+			if (!markerLayer) { return }
+
+			this.subscriptions.add(markerLayer.onDidCreateMarker(marker => {
+				this.handleMarker(marker)
+			}))
+
+			markerLayer.findMarkers().forEach(marker => this.handleMarker(marker))
+		})
+	}
+
+	handleMarker (marker) {
+		const { id } = marker
+		const decoration = this.minimap.decorateMarker(marker, { type: 'line', class: 'bookmark', plugin: 'bookmarks' })
+		this.decorationsByMarkerId[id] = decoration
+		this.decorationSubscriptionsByMarkerId[id] = decoration.onDidDestroy(() => {
+			this.decorationSubscriptionsByMarkerId[id].dispose()
+
+			delete this.decorationsByMarkerId[id]
+			delete this.decorationSubscriptionsByMarkerId[id]
+		})
+	}
+
+	destroy () {
+		for (const id in this.decorationsByMarkerId) {
+			const decoration = this.decorationsByMarkerId[id]
+			this.decorationSubscriptionsByMarkerId[id].dispose()
+			decoration.destroy()
+
+			delete this.decorationsByMarkerId[id]
+			delete this.decorationSubscriptionsByMarkerId[id]
+		}
+
+		this.subscriptions.dispose()
+	}
+}
+
+module.exports = MinimapBookmarksBinding

lib/minimap-bookmarks-binding.coffee

@@ -0,0 +1,73 @@
+/*
+ * decaffeinate suggestions:
+ * DS102: Remove unnecessary code created because of implicit returns
+ * DS201: Simplify complex destructure assignments
+ * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
+ */
+const { CompositeDisposable } = require('atom')
+let MinimapBookmarksBinding
+
+module.exports = {
+	isActive () {
+		return this.active
+	},
+
+	activate () {
+		this.active = false
+		this.subscriptions = new CompositeDisposable()
+		this.bindings = {}
+		require('atom-package-deps').install('minimap-git-diff')
+	},
+
+	consumeMinimapServiceV1 (minimap) {
+		this.minimap = minimap
+		this.minimap.registerPlugin('bookmarks', this)
+	},
+
+	deactivate () {
+		if (this.minimap) {
+			this.minimap.unregisterPlugin('bookmarks')
+		}
+		this.minimap = null
+	},
+
+	activatePlugin () {
+		if (this.active) {
+			return
+		}
+
+		const bookmarksPkg = atom.packages.getLoadedPackage('bookmarks')
+		if (!bookmarksPkg) {
+			return
+		}
+		const bookmarks = bookmarksPkg.mainModule
+		this.active = true
+
+		this.minimapsSubscription = this.minimap.observeMinimaps(minimap => {
+			if (!MinimapBookmarksBinding) {
+				MinimapBookmarksBinding = require('./minimap-bookmarks-binding')
+			}
+
+			const binding = new MinimapBookmarksBinding(minimap, bookmarks)
+			this.bindings[minimap.id] = binding
+
+			const subscription = minimap.onDidDestroy(() => {
+				binding.destroy()
+				this.subscriptions.remove(subscription)
+				subscription.dispose()
+				delete this.bindings[minimap.id]
+			})
+			this.subscriptions.add(subscription)
+		})
+	},
+
+	deactivatePlugin () {
+		if (!this.active) { return }
+
+		for (const id in this.bindings) { const binding = this.bindings[id]; binding.destroy() }
+		this.bindings = {}
+		this.active = false
+		this.minimapsSubscription.dispose()
+		this.subscriptions.dispose()
+	},
+}