Merge pull request ipfs#8555 from feat/remove-submodule

refactor: remove dir-index-html submodule

assets/README.md

@@ -3,7 +3,7 @@
 This directory contains the go-ipfs assets:
 
 * Getting started documentation (`init-doc`).
-* Directory listing HTML template (`dir-index-html` git submodule).
+* Directory listing HTML template (`dir-index-html`).
 
 These assets are compiled into `bindata.go` with `go generate`.
 
@@ -16,37 +16,4 @@ assets directory:
 
 ```
 go generate .
-```
-
-## Updating dir-index-html
-
-Upstream: https://github.com/ipfs/dir-index-html
-
-dir-index-html is a git submodule. To update, run the following commands from
-this directory.
-
-```bash
-> git -C dir-index-html pull
-> git -C dir-index-html checkout vX.Y.Z # target version
-```
-
-Then, you'll need to commit the updated submodule _before_ regenerating
-`bindata.go`. Otherwise, `go generate` will checkout the checked-in version of
-dir-index-html.
-
-```bash
-> git add dir-index-html
-> git commit -m 'chore: update dir-index-html to vX.Y.Z'
-```
-
-Finally, re-generate the directory index HTML template, tidy, and amend the previous
-commit.
-
-```bash
-> go generate .
-> git add bindata.go
-> git add bindata_version_hash.go
-> go mod tidy
-> git commit --amend --no-edit
-
-```
+```

assets/assets.go

@@ -1,4 +1,4 @@
-//go:generate git submodule update --init ./dir-index-html
+//go:generate npm run build --prefix ./dir-index-html/
 //go:generate go run github.com/go-bindata/go-bindata/v3/go-bindata -mode=0644 -modtime=1403768328 -pkg=assets init-doc dir-index-html/dir-index.html dir-index-html/knownIcons.txt
 //go:generate gofmt -s -w bindata.go
 //go:generate sh -c "sed -i \"s/.*BindataVersionHash.*/BindataVersionHash=\\\"$(git hash-object bindata.go)\\\"/\" bindata_version_hash.go"

assets/dir-index-html/README.md

@@ -0,0 +1,26 @@
+# dir-index-html
+
+> Directory listing HTML for `go-ipfs` gateways
+
+![](https://user-images.githubusercontent.com/157609/88379209-ce6f0600-cda2-11ea-9620-20b9237bb441.png)
+
+## Updating
+
+When making updates to the directory listing page template, please note the following:
+
+1. Make your changes to the (human-friendly) source documents in the `src` directory and run `npm run build`
+3. Before testing or releasing, go to the top-level `./assets` directory and make sure to run the `go generate .` script to update the bindata version
+
+## Testing
+
+1. Make sure you have [Go](https://golang.org/dl/) installed
+2. Start the test server, which lives in its own directory:
+
+```bash
+> cd test
+> go run .
+```
+This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page.
+
+If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `npm run build` to generate the minified artifact that the test is looking for.
+

assets/dir-index-html/index.go

@@ -0,0 +1 @@
+package dirindexhtml

assets/dir-index-html/knownIcons.txt

@@ -0,0 +1,65 @@
+.aac
+.aiff
+.ai
+.avi
+.bmp
+.c
+.cpp
+.css
+.dat
+.dmg
+.doc
+.dotx
+.dwg
+.dxf
+.eps
+.exe
+.flv
+.gif
+.h
+.hpp
+.html
+.ics
+.iso
+.java
+.jpg
+.jpeg
+.js
+.key
+.less
+.mid
+.mkv
+.mov
+.mp3
+.mp4
+.mpg
+.odf
+.ods
+.odt
+.otp
+.ots
+.ott
+.pdf
+.php
+.png
+.ppt
+.psd
+.py
+.qt
+.rar
+.rb
+.rtf
+.sass
+.scss
+.sql
+.tga
+.tgz
+.tiff
+.txt
+.wav
+.wmv
+.xls
+.xlsx
+.xml
+.yml
+.zip

assets/dir-index-html/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "dir-index-html",
+  "description": "Directory listing HTML for go-ipfs gateways",
+  "version": "1.3.0",
+  "private": true,
+  "homepage": "https://github.com/ipfs/go-ipfs",
+  "license": "MIT",
+  "scripts": {
+    "start": "cd test && go run .",
+    "build": "npm run build:clean && npm run build:remove-style-links && npm run build:minify-wrap-css && npm run build:combine-html-css && npm run build:remove-unused",
+    "build:clean": "rm dir-index.html",
+    "build:remove-style-links": "sed '/<link rel=\"stylesheet\"/d' ./src/dir-index.html > ./base-html.html",
+    "build:minify-wrap-css": "(echo \"<style>\" && cat ./src/icons.css ./src/style.css | tr -d \"\t\n\r\" && echo && echo \"</style>\") > ./minified-wrapped-style.html",
+    "build:combine-html-css": "sed '/<\\/title>/ r ./minified-wrapped-style.html' ./base-html.html > ./dir-index.html",
+    "build:remove-unused": "rm ./base-html.html && rm ./minified-wrapped-style.html"
+  }
+}

assets/dir-index-html/src/dir-index.html

@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+{{ $root := . }}
+<html lang="en">
+<head>
+<meta charset="utf-8" />
+<meta name="description" content="A directory of files hosted on the distributed, decentralized web using IPFS">
+<meta property="og:title" content="Files on IPFS">
+<meta property="og:description" content="{{ .Path }}">
+<meta property="og:type" content="website">
+<meta property="og:image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="twitter:title" content="{{ .Path }}">
+<meta name="twitter:description" content="A directory of files hosted on the distributed, decentralized web using IPFS">
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="twitter:creator" content="@ipfs">
+<meta name="twitter:site" content="@ipfs">
+<meta name="image" content="https://gateway.ipfs.io/ipfs/QmSDeYAe9mga6NdTozAZuyGL3Q1XjsLtvX28XFxJH8oPjq">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlo89/56ZQ/8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACUjDu1lo89/6mhTP+zrVP/nplD/5+aRK8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHNiIS6Wjz3/ubFY/761W/+vp1D/urRZ/8vDZf/GvmH/nplD/1BNIm8AAAAAAAAAAAAAAAAAAAAAAAAAAJaPPf+knEj/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf+tpk7/nplD/wAAAAAAAAAAAAAAAJaPPf+2rVX/vrVb/761W/++tVv/vrVb/6+nUP+6tFn/y8Nl/8vDZf/Lw2X/y8Nl/8G6Xv+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/761W/+vp1D/urRZ/8vDZf/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/vrVb/761W/++tVv/r6dQ/7q0Wf/Lw2X/y8Nl/8vDZf/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf++tVv/vrVb/761W/++tVv/vbRa/5aPPf+emUP/y8Nl/8vDZf/Lw2X/y8Nl/8vDZf+emUP/AAAAAAAAAACWjz3/vrVb/761W/++tVv/vrVb/5qTQP+inkb/op5G/6KdRv/Lw2X/y8Nl/8vDZf/Lw2X/nplD/wAAAAAAAAAAlo89/761W/++tVv/sqlS/56ZQ//LxWb/0Mlp/9DJaf/Kw2X/oJtE/7+3XP/Lw2X/y8Nl/56ZQ/8AAAAAAAAAAJaPPf+9tFr/mJE+/7GsUv/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+xrFL/nplD/8vDZf+emUP/AAAAAAAAAACWjz3/op5G/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+inkb/nplD/wAAAAAAAAAAAAAAAKKeRv+3slb/0cpq/9HKav/Rymr/0cpq/9HKav/Rymr/0cpq/9HKav+1sFX/op5G/wAAAAAAAAAAAAAAAAAAAAAAAAAAop5GUKKeRv/Nxmf/0cpq/9HKav/Rymr/0cpq/83GZ/+inkb/op5GSAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G16KeRv/LxWb/y8Vm/6KeRv+inkaPAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAop5G/6KeRtcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/n8AAPgfAADwDwAAwAMAAIABAACAAQAAgAEAAIABAACAAQAAgAEAAIABAACAAQAAwAMAAPAPAAD4HwAA/n8AAA==" />
+<link rel="stylesheet" href="style.css"/>
+<link rel="stylesheet" href="icons.css">
+<title>{{ .Path }}</title>
+</head>
+<body>
+  <div id="page-header">
+    <div id="page-header-logo" class="ipfs-logo">&nbsp;</div>
+    <div id="page-header-menu">
+      <div class="menu-item-wide"><a href="https://ipfs.io" target="_blank" rel="noopener noreferrer">About IPFS</a></div>
+      <div class="menu-item-wide"><a href="https://ipfs.io#install" target="_blank" rel="noopener noreferrer">Install IPFS</a></div>
+      <div class="menu-item-narrow"><a href="https://ipfs.io" target="_blank" rel="noopener noreferrer">About</a></div>
+      <div class="menu-item-narrow"><a href="https://ipfs.io#install" target="_blank" rel="noopener noreferrer">Install</a></div>
+      <div>
+        <a href="https://github.com/ipfs/dir-index-html/issues/" target="_blank" rel="noopener noreferrer">
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 18.4 21"><circle cx="7.5" cy="4.8" r="1"/><circle cx="11.1" cy="4.8" r="1"/><path d="M12.7 8.4c-0.5-1.5-1.9-2.5-3.5-2.5 -1.6 0-3 1-3.5 2.5H12.7z"/><path d="M8.5 9.7H5c-0.5 0.8-0.7 1.7-0.7 2.7 0 2.6 1.8 4.8 4.2 5.2V9.7z"/><path d="M13.4 9.7H9.9v7.9c2.4-0.4 4.2-2.5 4.2-5.2C14.1 11.4 13.9 10.5 13.4 9.7z"/><circle cx="15.7" cy="12.9" r="1"/><circle cx="15.1" cy="15.4" r="1"/><circle cx="15.3" cy="10.4" r="1"/><circle cx="2.7" cy="12.9" r="1"/><circle cx="3.3" cy="15.4" r="1"/><circle cx="3.1" cy="10.4" r="1"/></svg>
+        </a>
+      </div>
+    </div>
+  </div>
+  <div id="content">
+    <div id="content-header" class="d-flex flex-wrap">
+      <div>
+        <strong>
+          Index of
+          {{ range .Breadcrumbs -}}
+          /{{ if .Path }}<a href="{{ $root.GatewayURL }}{{ .Path | urlEscape }}">{{ .Name }}</a>{{ else }}{{ .Name }}{{ end }}
+          {{- else }}
+          {{ .Path }}
+          {{ end }}
+        </strong>
+        {{ if .Hash }}
+        <div class="ipfs-hash" translate="no">
+          {{ .Hash }}
+        </div>
+        {{ end }}
+      </div>
+      {{ if .Size }}
+      <div class="no-linebreak flex-shrink-1 ml-auto">
+        <strong>&nbsp;{{ .Size }}</strong>
+      </div>
+      {{ end }}
+    </div>
+    <div class="table-responsive">
+    <table>
+      <tr>
+        <td class="type-icon">
+          <div class="ipfs-_blank">&nbsp;</div>
+        </td>
+        <td>
+          <a href="{{.BackLink | urlEscape}}">..</a>
+        </td>
+        <td></td>
+        <td></td>
+      </tr>
+      {{ range .Listing }}
+      <tr>
+        <td class="type-icon">
+          <div class="{{iconFromExt .Name}}">&nbsp;</div>
+        </td>
+        <td>
+          <a href="{{ .Path | urlEscape }}">{{ .Name }}</a>
+        </td>
+        <td class="no-linebreak">
+          {{ if .Hash }}
+          <a class="ipfs-hash" translate="no" href={{ if $root.DNSLink }}"https://cid.ipfs.io/#{{ .Hash | urlEscape}}" target="_blank" rel="noreferrer noopener"{{ else }}"{{ $root.GatewayURL }}/ipfs/{{ .Hash | urlEscape}}?filename={{ .Name | urlEscape }}"{{ end }}>
+            {{ .ShortHash }}
+          </a>
+          {{ end }}
+        </td>
+        <td class="no-linebreak">{{ .Size }}</td>
+      </tr>
+      {{ end }}
+    </table>
+    </div>
+  </div>
+</body>
+</html>