Writing
Colonial placenames
I use an abridged and adapted version of the UnMonumental Style Guide to treat placenames:
- I prefer Indigenous placenames if they are recognisable by the target audience. For example, I would use:
- Gulaga rather than Mount Dromedary
- Baranguba rather than Montague Island
- Uluru rather than Ayers Rock
- In instances where a colonial placename has no Indigenous substitute which can convey the same meaning, I dishonor it with a strikethrough or similar corruption:
AustraliaNew South Wales- 'australia' (when text cannot be struck through, such as in
metadescriptions)
- I don't strike through romanisations of indigenous placenames:
- Bermagui
Code
This Astro file sums up my style guide for JavaScript, TypeScript, Astro and CSS:
---
// Format files with Prettier, configured to use single quotes.
import Emoji from './Emoji.astro';
// Use .jpg instead of .jpeg
import wavingHand from './waving-hand.jpg';
// Use upper camel case for types.
type FullName = {
// Unless otherwise noted, use lower camel case.
firstName: string;
lastName: string;
};
interface Props {
fullName: FullName;
}
const { fullName } = Astro.props;
// Upper camel case for classes.
class Greeter {
greet(fullName: FullName) {
// Always use template literals for concatenation.
return `Hello, ${fullName.firstName} ${fullName.lastName}!`;
}
}
const greeter = new Greeter();
---
<style>
.greeting-paragraph {
/* Use kebab case for variables, upper camel case for <system-color> names. */
--background-color: AccentColor;
/* Use 'american' English for names which are not user-facing. */
--text-color: AccentColorText;
color: var(--text-color, gray);
background: var(--background-color);
}
</style>
{
/* Always use JS-style comments in Astro unless the comment is targeting other developers: */
}
<!-- Find the source code at https://example.com/code -->
{/* Use kebab case for identifiers in HTML. */}
<p class='greeting-paragraph'>
{greeter.greet(fullName)}
{/* Upper camel case for components (obviously). */}
<Emoji src={wavingHand} alt='Waving hand' />
</p>