Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove inline Javascript #152

Merged
merged 6 commits into from
Dec 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion res/js/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import swal from 'sweetalert2';
import * as ArrayFrom from 'array-from';
import {Category, Simulation} from '../../lib/types';
import { template as reactiveTemplate } from '../templates/reactive-template';

if (!(Array as any).from) (Array as any).from = ArrayFrom;

Expand Down Expand Up @@ -39,7 +40,7 @@ const currentCategory = (localStorage && localStorage[window.lsPrefix + 'current

const ractive = new Ractive({
el: '#ractive-target',
template: '#ractive-template',
template: reactiveTemplate,
computed: {
languages() {
return Object.entries(this.get('languageMappings'));
Expand Down
43 changes: 1 addition & 42 deletions res/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,50 +38,9 @@
<div id="container">
<div id='ractive-target'></div>
</div>

<script id='ractive-template' type='text/html'>
<div class="language-container">
{{#if languages.length > 1}}
<label>
<select value="{{selectedLanguage}}">
{{#each languages}}
<option value='{{this[0]}}'>{{this[1]}}</option>
{{/each}}
</select>
</label>
{{/if}}
<label>
<select value='{{selectedCategory}}'>
<option value='all'>All categories</option>
{{#each categories}}
<option value='{{makeCategoryId(.)}}'>{{makeCategoryName(.)}}</option>
{{/each}}
</select>
</label>
</div>
<div class="card-cont">
{{#each simulations}}
<div class="sim-card" on-click='showConfirm'>
<img src="../I/{{id}}.png" alt="Screenshot of the {{display}}" />
<div class="overlay">
<i class="fa fa-info-circle" aria-hidden="true"></i>
<h2>{{title}}</h2>
</div>
</div>
{{/each}}
</div>
</script>
</body>

<script>
window.importedData = <!-- REPLACEMEINCODE -->;

window.lsPrefix = 'kiwix';

<!-- SETLSPREFIX -->

</script>

<script src='../-/catalog.js'></script>
<script src='../-/dist.js'></script>

</html>
9 changes: 9 additions & 0 deletions res/templates/catalog.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

export const catalogJs = (catalog: {}, lsPrefix: string): string => {

return `window.importedData = ${JSON.stringify(catalog)};

window.lsPrefix = 'kiwix';

lsPrefix = '${lsPrefix}';`;
};
32 changes: 32 additions & 0 deletions res/templates/reactive-template.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
export const template: string = `
<div class="language-container">
{{#if languages.length > 1}}
<label>
<select value="{{selectedLanguage}}">
{{#each languages}}
<option value='{{this[0]}}'>{{this[1]}}</option>
{{/each}}
</select>
</label>
{{/if}}
<label>
<select value='{{selectedCategory}}'>
<option value='all'>All categories</option>
{{#each categories}}
<option value='{{makeCategoryId(.)}}'>{{makeCategoryName(.)}}</option>
{{/each}}
</select>
</label>
</div>
<div class="card-cont">
{{#each simulations}}
<div class="sim-card" on-click='showConfirm'>
<img src="../I/{{id}}.png" alt="Screenshot of the {{display}}" />
<div class="overlay">
<i class="fa fa-info-circle" aria-hidden="true"></i>
<h2>{{title}}</h2>
</div>
</div>
{{/each}}
</div>
`;
15 changes: 7 additions & 8 deletions steps/export.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {Presets, SingleBar} from 'cli-progress';
// @ts-ignore
import * as langs from '../state/get/languages.json';
import { exit } from 'yargs';
import { catalogJs } from '../res/templates/catalog';

dotenv.config();

Expand Down Expand Up @@ -131,14 +132,12 @@ const exportTarget = async (target: Target) => {
}

// Generate index file
const templateHTML = await fs.promises.readFile(resDir + 'template.html', 'utf8');
// Pretty hacky - doing a replace on the HTML. Investigate other ways
await fs.promises.writeFile(targetDir + 'index.html',
templateHTML
.replace('<!-- REPLACEMEINCODE -->', JSON.stringify(catalog))
.replace('<!-- SETLSPREFIX -->', `lsPrefix = "${target.output}";`), 'utf8');

await Promise.all(glob.sync(`${resDir}/**/*`, {ignore: ['*.ts', 'template.html'], nodir: true})
await fs.promises.copyFile(resDir + 'template.html', targetDir + 'index.html');

// Generate catalog JS
await fs.promises.writeFile(targetDir + 'catalog.js', catalogJs(catalog, target.output), 'utf8');

await Promise.all(glob.sync(`${resDir}/**/*`, {ignore: ['*/templates/*', '*.ts', 'template.html'], nodir: true})
.map(async (file) => fs.promises.copyFile(file, `${targetDir}${path.basename(file)}`))
);

Expand Down
2 changes: 1 addition & 1 deletion test/e2e.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ describe('Validate ZIM', () => {
const article = await zim.getArticleByUrl(`A/index.html`);
expect(article).toBeDefined();
expect(article.mimeType).toEqual('text/html');
expect(article.data.length).toBeGreaterThan(100000);
expect(article.data.length).toBeGreaterThan(1900);
done();
});

Expand Down