FluentLibrary¶

Overview¶

An entry point for the Fluent library. In the browser-and-node directory, it lets Fluent be used by both simulation code and during the grunt modulify process. Follow tsconfig-dependencies.json to see how Fluent code is referenced for typescript. See the README in the sherpa/lib/fluent directory for more information on how Fluent is set up for PhET simulations.

@author Jesse Greenberg (PhET Interactive Simulations)

Class FluentLibrary¶

import { FluentLibrary } from 'scenerystack/chipper';

Static Methods¶

getFluentMessageKeys( fluentFileString : string ) : string[]¶

Gets all message keys (excluding terms) from a Fluent file string. This exists in FluentLiberary (instead of FluentUtils) because it needs to be used outside of simulation code.

verifyFluentFile( fluentFileString : string )¶

Verify syntax in the fluent file. Right now it checks for: - Message keys should use camelCase instead of dashes. - All terms used in the file should be defined. - All selectors must have a default case. - Terms are not allowed to use placeables because terms used in placeables cannot take forwarded variables. - This is PhET specific and was added because it an easy programming mistake to assume that terms with placeables can be used like messages. This can be relaxed if needed in the future.

Type FluentPattern¶

import type { FluentPattern } from 'scenerystack/chipper';

string | ComplexPattern

Source Code¶

See the source for FluentLibrary.ts in the chipper repository.